Provides script language access to C++ objects of this type.
| Class Hierarchy | No registered superclass. |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| <Vec> | Vec | Constructs a <Vec> object with the specified X, Y, and Z coordinates. |
| int32 | Add | Adds the vector 'A' to this vector. |
| int32 | AddScaled | Scales the vector 'A' by 'Scale', then adds the result to this vector. |
| int32 | Assign | Assigns the components from the vector 'Other' to 'this'. |
| int32 | BindIterators | Binds iterators to this object. |
| int32 | BindPointer | Binds a <MemoryPointer> or subclass to this object. The <MemoryPointer> becomes a pointer to this object that can be passed to compatible functions. |
| int32 | Blend | Interpolates this vector and 'End', using 1.0 - 'Alpha' and 'Alpha' as the blending weights. |
| int32 | BlendAB | Interpolates the vectors 'Start' and 'End', using 'AlphaA' and 1.0 - 'AlphaA' as the blending weights, respectively. |
| int32 | BlendABC | Undocumented |
| int32 | Cross | Computes the cross product between 'A' and 'B', and stores the result in this vector. |
| float64 | DistanceToLine | Calculates the distance from 'this' to a line which passes through two vectors 'A' and 'B'. |
| float64 | Dot | Returns the dot product of this vector and the vector 'A'. |
| int32 | Fill | Sets all the items in the vector to this value. |
| <Float64Iterator> | First | Returns an iterator positioned at the start of the collection. |
| float64 | GetDistance | Returns the distance between this vector and the vector 'End'. |
| float64 | GetDistanceXY | Returns the distance between this vector and the vector 'End'. |
| int32 | GetElementSize | Returns the size in bytes of each element of the array. Returns 8 because a <float64> requires 8 bytes of storage for each element in the array. |
| <Float64Pointer> | GetPointer | Returns a pointer to this object. The pointer object is allocated with new so you must use auto in the declaration or you must manually delete the pointer object. For example: auto Float16Pointer ptr = object.GetPointer(). |
| int32 | GetSizeInBytes | Returns the size in bytes of the <VecArray>, which is the total number of bytes currently being used by the <VecArray>, and does not include any allocated reserve. |
| <Float64ArrayView> | GetView | Returns a <Float16ArrayView> that contains first and last iterators for the collection. |
| <Float64Iterator> | Last | Returns an iterator positioned at the end of the collection. |
| float64 | LengthXY | Returns the 2-dimensional (x, y) length of the vector. |
| float64 | Maximize | Selects the maximum values for each component of 'this' and the vector 'A', and assigns the values to 'this'. |
| float64 | Minimize | Selects the minimum values for each component of 'this' and the vector 'A', and assigns the values to 'this'. |
| int32 | Multiply | Multiplies this vector with the vector 'A'. |
| float64 | Normalize | Scales the vector, placing it on the unit sphere. |
| int32 | ProjectOnto | Projects this vector onto the vector 'ProjectOnto'. |
| int32 | Scale | Scales this vector with the scalar value 'Scale'. |
| int32 | Set | Sets the X, Y, and Z coordinates of the vector. |
| int32 | SetDistance | Moves the vector a specified distance from the vector 'End'. |
| int32 | Subtract | Subtracts the vector 'A' from this vector. |
| int32 | Transform | Undocumented |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <Vec> | Value | Returns the value of this object's underlying <Vec> object. For example: to assign the value of this object to another <Vec> object. |
| float64 | Length | Gets or sets the length of this vector, which is the distance from this vector to the origin. |
| float64 | X | Gets or sets the X component of the vector. |
| float64 | Y | Gets or sets the Y component of the vector. |
| float64 | Z | Gets or sets the Z component of the vector. |