<ColorArray> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyNo registered superclass.

Function Members

Function members are as follows:

Return Type Function Name Documentation
<ColorArray>ColorArrayThe <ColorArray> constructor.
int32AddAdds a <Color> object to the end of the array.
int32BindIteratorsBinds iterators to this object.
int32ClearClears the array and frees the underlying memory, but does not destroy the <ColorArray> object.
int32CombineGiven ArrayA ( this array ) and ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA.
int32ConvertBytesToCountSets 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, <float64> values are 8 bytes each, so providing a value of 16 bytes ensures the array count is set to 2. Similarly, providing a value of 17 bytes, which is not a multiple of 8, ensures the array count is set to 3.
int32CopyCopies the value of the source array into this array.
int32DelDeletes an item from the array.
int32ElementSizeReturns the size in bytes of each element of the array. Returns 4 because a <Color> object requires 4 bytes of storage for each element in the array.
int32FillSets all the items in the <ColorArray> to this value.
int32FindFinds a value in the <ColorArray> and returns the index or -1 if the value is not found.
<Uint8Iterator>FirstReturns an iterator positioned at the start of the collection.
<Color>GetReturns a pointer to the <Color> object at the specified index.
int32GetCountReturns the count of the underlying array object.
<Color>GetFirstReturns a pointer to the first object in the array or returns nullptr if the array is empty.
<Color>GetLastReturns a pointer to the last object in the array or returns nullptr if the array is empty.
<Uint8Pointer>GetPointerReturns 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 Uint8Pointer ptr = object.GetPointer().
<Uint8ArrayView>GetViewReturns a <Uint8ArrayView> that contains first and last iterators for the collection.
int32InsertInserts a <Color> value into the array. Does not deallocate or destroy the <Color> object. May incur re-allocation costs depending on the size of any allocated reserve.
<Uint8Iterator>LastReturns an iterator positioned at the end of the collection.
int32MergeAdds a <Color> object to the end if the value is not already in the <ColorArray>.
int32MoveMoves the memory from the source array to the destination array. Leaves the source array empty with a count of zero.
int32PopPops the first item off the top of the stack.
int32Print1DPrints the array in 1D into a <StrList> object.
int32Print2DPrints a <Float64Array> in 2D into a <StrList> object.
int32PushPushes a <Color> object onto the stack ( at the end ).
int32RelocateRelocates a chunk of the array to a new index.
int32SetSets the value at the specified index to the value of the specified object.
int32SetViewInternal use only.
int32ShrinkShrinks the array to a sub-range.
int32SizeInBytesReturns the size in bytes of the array, which is the total number of bytes currently being used by the array, and does not include any allocated reserve.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
Color[]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.
<ColorArray>ValueReturns the value of this object's underlying <ColorArray>. For example: to assign the value of this object to another <ColorArray>.
int32CountGets or sets the number of objects in the array. Setting the count to zero frees all the memory owned by the array, but does not destroy the array object.
int32ReserveGets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer.