HPL2/HPL2 Helper Scripts/Vectors - Revision history

Mrbehemo: Added cBezier GetSegmentHandle() and GetMinLength()

2024-02-11T02:43:22Z

Added cBezier GetSegmentHandle() and GetMinLength()

Mrbehemo: Added DotProduct(), CrossProduct(), vector * and /

2024-02-11T02:37:39Z

Added DotProduct(), CrossProduct(), vector * and /

Mrbehemo at 01:46, 11 February 2024

2024-02-11T01:46:05Z

Mrbehemo at 00:26, 1 December 2023

2023-12-01T00:26:40Z

Mrbehemo: Changed "units" to "m"

2023-11-26T16:52:22Z

Changed "units" to "m"

Mrbehemo: Additional cSpline constructors.

2023-11-26T12:18:17Z

Additional cSpline constructors.

Mrbehemo: /* Behaviours */

2023-11-25T03:04:32Z

Behaviours

Mrbehemo: /* Advanced info */

2023-11-25T03:03:33Z

Advanced info

Mrbehemo: /* Component properties */

2023-11-25T03:02:27Z

Component properties

Mrbehemo: Final draft of first version done.

2023-11-25T02:54:35Z

Final draft of first version done.

Show changes

@@ Line 934: / Line 934: @@
 #''cBezier ahSegment'' - A bezier to be appended to the spline.
 #''bool abSnap'' - Whether to adjust the previous segment to connect to the new one. (Optional, default = true)
@@ Line 991: / Line 999: @@
 </syntaxhighlight>
 Estimates the approximate length of the entire spline.
 #''enumLengthType aSquaredOption'' - Can be lengthFinal or lengthSquared. (Optional, default = lengthFinal)

@@ Line 169: / Line 169: @@
 Some '''arithmetic''' operators have been implemented for '''a cVector with another cVector''':
-<syntaxhighlight lang="cpp"> +  -  =  +=  -= </syntaxhighlight>
+<syntaxhighlight lang="cpp"> +  -  *  /  +=  -=  *=  /= </syntaxhighlight>
 Additional '''arithmetic''' operators have been implemented for '''a cVector with a float''':
 <syntaxhighlight lang="cpp"> +  -  *  /  +=  -=  *=  /= </syntaxhighlight>
-The '''multiplication''' operator <code>*</code> used with a cVector on another cVector will return the '''dot product''' of the two vectors, as a float.
+Using <code>*</code> or <code>/</code> to multiply or divide a vector by a scalar value (float or double) will scale the vector, component-wise.
 The '''equality''' operator <code> == </code> checks for an exact match between two cVectors. '''Comparison''' operators <code> > >= < <= </code> compare the '''square length''' of the vectors.
 The '''index''' operator <code> myVector[i] </code> allows read-only access to the vector's components by index.
 The '''assignment''' operator <code> = </code> assigns a new value by duplicating the components. This may also '''resize''' the dimension of the vector.
@@ Line 306: / Line 320: @@
 // This example has the same result as the previous one, for Normal().
 </syntaxhighlight>
@@ Line 450: / Line 483: @@
 Note: the results of division operations with ints maybe truncated. That is, in integer calculations, 1 / 2 = 0.
-Some '''arithmetic''' operators have been implemented for '''a cPoint with another cPoint''':
+'''Arithmetic''' operators have been implemented for '''a cPoint with another cPoint''':
-<syntaxhighlight lang="cpp"> +  -  =  +=  -= </syntaxhighlight>
+<syntaxhighlight lang="cpp"> +  -  *  /  +=  -=  *=  /= </syntaxhighlight>
 Additional '''arithmetic''' operators have been implemented for '''a cPoint with an int''':
 <syntaxhighlight lang="cpp"> +  -  *  /  +=  -=  *=  /= </syntaxhighlight>
-The '''multiplication''' operator <code>*</code> used with a cPoint on another cPoint will return the '''dot product''' of the two vectors, as a truncated int.
+The '''multiplication''' operator <code>*</code> used with a cPoint and an int, or a pair of cPoint, will scale the point component-wise.
 The '''equality''' operator <code> == </code> checks for an exact match between two cPoints. '''Comparison''' operators <code> > >= < <= </code> compare the '''square length''' of the vectors.
 The '''index''' operator <code> myVector[i] </code> allows read-only access to the vector's components by index.
 The '''assignment''' operator <code> = </code> assigns a new value by duplicating the components. This may also '''resize''' the dimension of the vector.

← Older revision		Revision as of 01:46, 11 February 2024
Line 59:		Line 59:
	cVector and cPoint can both be used for 2d or 3d vectors. The vector classes are designed to be agnostic of dimensionality. The maximum number of dimensions for all vector classes is defined by ulVectorDimMax. The default value is 16, but an advanced user may want to edit that value. cVector and it's derived classes can have any number of dimensions from 0 to, in theory, 65535, although either extreme would be ridiculous. Using a maximum larger than 65535 could cause problems.		cVector and cPoint can both be used for 2d or 3d vectors. The vector classes are designed to be agnostic of dimensionality. The maximum number of dimensions for all vector classes is defined by ulVectorDimMax. The default value is 16, but an advanced user may want to edit that value. cVector and it's derived classes can have any number of dimensions from 0 to, in theory, 65535, although either extreme would be ridiculous. Using a maximum larger than 65535 could cause problems.

−	Arithmetic, and some ~~mathods~~, can work with differently dimensioned vectors. For example <code>a[X,Y,Z] + b[X,Y]</code> has the same effect as <code>a[X,Y,Z] + b[X,Y,0]</code>.	+	Arithmetic, and some methods, can work with differently dimensioned vectors. For example <code>a[X,Y,Z] + b[X,Y]</code> has the same effect as <code>a[X,Y,Z] + b[X,Y,0]</code>.

@@ Line 904: / Line 904: @@
 bool UpdateSegment(uint aulIndex, cBezier ahSegment, bool abSnap = true)
 </syntaxhighlight>
-Appends a bezier onto the spline as new segment. Returns false if the segment does not already exist, or true if it was successfully added.
+Updates an existing segment by index, replacing it with a new bezier. Returns false if the segment does not already exist, or true if it was successfully updated.
 <br>abSnap is optional. If omitted, it defaults to true. If abSnap is true then the end point and exit tangent of the previous segment, and the start point and entrance tangent of the next segment will be adjusted to connect to the updated segment.
 #''uint aulIndex'' - The index of the segment to be replaced.

@@ Line 266: / Line 266: @@
 cVector vMyRectangle = cVector(10.0f, 15.0f);
 float fMyHypotenuse = vMyRectangle.Length();
-// fMyHypotenuse becomes the length of the diagonal line across a rectangle 10 by 15 units.
+// fMyHypotenuse becomes the length of the diagonal line across a rectangle 10m by 15m.
 </syntaxhighlight>
@@ Line 548: / Line 548: @@
 cPoint vMyRectangle = cPoint(10, 15);
 int lMyHypotenuse = vMyRectangle.Length();
-// lMyHypotenuse becomes the length of the diagonal line across a rectangle 10 by 15 units.
+// lMyHypotenuse becomes the length of the diagonal line across a rectangle 10m by 15m.
 </syntaxhighlight>

@@ Line 46: / Line 46: @@
 ===Component properties===
 The simplest way to access the components of a 2d or 3d vector is through the named properties. A 2d or 3d cVector provides X and Y, or X, Y and Z properties. cRotator has Pitch, Yaw and Roll. See the notes below for more details on each class.
 ===Indices===
@@ Line 58: / Line 59: @@
 cVector and cPoint can both be used for 2d or 3d vectors. The vector classes are designed to be agnostic of dimensionality. The maximum number of dimensions for all vector classes is defined by ulVectorDimMax. The default value is 16, but an advanced user may want to edit that value. cVector and it's derived classes can have any number of dimensions from 0 to, in theory, 65535, although either extreme would be ridiculous. Using a maximum larger than 65535 could cause problems.
-Arithmetic, and some methods, can work with differently dimensioned vectors. For example <code>a[X,Y,Z] + b[X,Y]</code> has the same effect as <code>a[X,Y,Z] + b[X,Y,0]</code>.
+Arithmetic, and some mathods, can work with differently dimensioned vectors. For example <code>a[X,Y,Z] + b[X,Y]</code> has the same effect as <code>a[X,Y,Z] + b[X,Y,0]</code>.
 =cVector=
@@ Line 76: / Line 78: @@
 </syntaxhighlight>
-An empty vector with a specific dimension (the number of components) can be made by passing an integer to the constructor:
+You can make an empty vector with a specific dimension (the number of components) by passing an integer to the constructor:
 <syntaxhighlight lang="cpp">
 	cVector myVector = cVector(3);		// Makes a 3d vector
@@ Line 85: / Line 87: @@
 A vector can be initialised with any number dimension up to ulVectorDimMax (default 16).
 ==Properties==
@@ Line 838: / Line 841: @@
-The cSpline class defines an array of Beziers that can be treated like a continuous path made of multiple curved segments. Internally cSpline is a cBezier array of a fixed maximum size (default = 16). Segments can be added to the spline either as whole cBezier segments using AddSegment(), or by adding one cVector point at a time using AddPoint().
+The cSpline class defines an array of Beziers that can be treated like a continuous path made of multiple curved segments. Internally cSpline is a cBezier array of a fixed maximum size (default = 16). The cSpline can be initialised using existing beziers, or with a single curve defined by args in the constructor.
 With the AddPoint() method, the spline is defined by providing the positions it should move through as individual points in space. Specific tangents can be provided (forward direction and scale) for each point, but are optional. When the final point is added, abLast should be specified as true to finish the spline and apply automatic tangents where needed. The automatic tangents make sure that path through each point is smooth, unless specific tangents were specified through AddPoint().
@@ Line 848: / Line 853: @@
 ==Behaviours==
-cSpline has three constructors:
+cSpline has seven constructors in total, with various options for initialising a curve.
 <syntaxhighlight lang="cpp">
 cSpline()							// Creates an empty spline with a maximum size of 16 bezier segments.
 cSpline(uint aulSegments)			// Creates an empty spline with capacity for the number of bezier segments specified by aulSegments.
 cSpline(cBezier aSegmentsArray)		// Takes an existing cBezier array and uses that to populate the new spline.
 </syntaxhighlight>