Static interface for types which can store their values as packed
elements in an array. These methods and properties are expected to be
defined on a constructor function.
- Source:
- See:
-
- PackableForInterpolation
Members
(static) packedLength :Number
The number of elements used to pack the object into an array.
Type:
- Number
- Source:
Methods
(static) pack(value, array, startingIndexopt)
Stores the provided instance into the provided array.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
value |
Object | The value to pack. | ||
array |
Array.<Number> | The array to pack into. | ||
startingIndex |
Number |
<optional> |
0 | The index into the array at which to start packing the elements. |
- Source:
(static) unpack(array, startingIndexopt, resultopt) → {Object}
Retrieves an instance from a packed array.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
array |
Array.<Number> | The packed array. | ||
startingIndex |
Number |
<optional> |
0 | The starting index of the element to be unpacked. |
result |
Object |
<optional> |
The object into which to store the result. |
- Source:
Returns:
The modified result parameter or a new Object instance if one was not provided.
- Type
- Object