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 |
|---|---|---|
| <VecArray> | VecArray | Constructs a <VecArray> object with the specified count and X, Y, and Z values. |
| int32 | Add | Adds a <Vec> to the end of the array. |
| 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 | Clear | Clears the array and frees the underlying memory, but does not destroy the <VecArray> object. |
| int32 | Combine | Given ArrayA ( this array ) and ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA. |
| int32 | ConvertBytesToCount | Sets the array count to a value guaranteed to be large enough to store an array of N bytes. Will round up to the nearest positive <int32> if the byte count provided does not align with the number of bytes per element. For example, ints are 4 bytes each, so providing a value of 16 bytes ensures the array count is set to 4. |
| int32 | Copy | Copies the value of the source into this <VecArray>. |
| int32 | Del | Removes an item from the array at the specified index. |
| int32 | ElementSize | Returns the size of the element of which the array is composed. In this case, it returns sizeof( <Vec> ), which is 24 bytes ( 3 * sizeof( double ) ). |
| int32 | Fill | Sets all the items in the <VecArray> to this value. |
| int32 | Find | Finds a <Vec> in the <VecArray>. |
| <Vec> | Get | Returns a pointer to the <Vec> object at the specified index. |
| int32 | GetCount | Returns the count of the underlying array object. |
| <Vec> | GetFirst | Returns a pointer to the first object in the array or returns nullptr if the array is empty. |
| <Vec> | GetLast | Returns a pointer to the last object in the array or returns nullptr if the array is empty. |
| <Uint8ArrayView> | GetView | Returns a <Float64ArrayView> that contains first and last iterators for the collection. |
| int32 | Insert | Inserts a <Vec> object into the array. May incur re-allocation costs depending on the size of any allocated reserve. |
| int32 | Merge | Adds a <Vec> object to the end if the value is not already in the <VecArray>. |
| int32 | Move | Moves the memory from the source array to the destination array. Leaves the source array empty with a count of zero. |
| int32 | Pop | Pops the first item off the top of the stack. |
| int32 | Push | Pushes an item onto the stack ( at the end ). |
| int32 | Relocate | Relocates a chunk of the array to a new index. |
| <Vec> | Remove | Removes a <Vec> object from the array, but does not destroy it. Returns a pointer to the <Vec> object that was removed from the array. |
| int32 | Set | Sets the value at the specified index. |
| int32 | Shrink | Shrinks the array to a sub-range. |
| int32 | SizeInBytes | 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. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| Vec[] | Objects[ index ] | Gets or sets the value of an element in the array at the specified index. The syntax is array.Objects[ n ], where n is a valid index into the array. |
| <VecArray> | Value | Returns the value of this object's underlying array. For example: to assign the value of this object to another <VecArray>. |
| int32 | Count | Gets or sets the number of <float64> values in the <VecArray>. Setting the count to zero frees all the memory owned by the <VecArray>, but does not destroy the <VecArray> object. |
| int32 | Reserve | Gets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer. |