Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » MemoryPointer » TypedIterator |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | ElementSize | Returns the size in byte of the underlying element. For example, if the <TypedIterator> object is really a <Float32Iterator> object, this function returns sizeof( float), which is 4 bytes. For an |
| int32 | GetCount | Returns the total count of elements this iterator can traverse. This refers to the count of the underlying object to (such as an <Image> or array object such as a <Float32Array>) to which this iterator is bound. For example: for a <Float32VectorArrayNode>, this count refers to the array count × 4 (the total number of components in a vec4). For an <Image> object, the count is the number of pixels × the number of channels in the format. |
| int32 | GetObjectArrayCount | Returns the count of the underlying collection. This refers to the count of the underlying object to (such as an <Image> or array object such as a <Float32Array>) to which this iterator is bound. This is different from the <TypedIterator> object's Position data member, which determines either the start or end point of the range begin/end represented by the iterator. |
| int32 | IsArrayType | Returns true if the underlying object to which the iterator is bound is an array type such as <Float32Array> or <Float32MatrixArray>. |
| int32 | IsColorType | Returns true if the underlying object to which the iterator is bound is any <Color> type. |
| int32 | IsFloat16Type | Returns true if the underlying object to which the iterator is bound is any <float16> type. |
| int32 | IsFloat32Type | Returns true if the underlying object to which the iterator is bound is any <float32> type. |
| int32 | IsFloat64Type | Returns true if the underlying object to which the iterator is bound is any <float64> type. |
| int32 | IsImageType | Returns true if the underlying object to which the iterator is bound is an <Image> object. |
| int32 | IsInt16Type | Returns true if the underlying object to which the iterator is bound is any <int16> type. |
| int32 | IsInt32Type | Returns true if the underlying object to which the iterator is bound is any <int32> type. |
| int32 | IsInt64Type | Returns true if the underlying object to which the iterator is bound is any <int64> type. |
| int32 | IsInt8Type | Returns true if the underlying object to which the iterator is bound is any <int8> type. |
| int32 | IsMatrixType | Returns true if the underlying object to which the iterator is bound is any matrix type. |
| int32 | IsScalarType | Returns true if the underlying object to which the iterator is bound is any scalar type. |
| int32 | IsStrType | Returns true if the underlying object to which the iterator is bound a <Str> object. |
| int32 | IsUint16Type | Returns true if the underlying object to which the iterator is bound is any <uint16> type. |
| int32 | IsUint32Type | Returns true if the underlying object to which the iterator is bound is any <uint32> type. |
| int32 | IsUint64Type | Returns true if the underlying object to which the iterator is bound is any <uint64> type. |
| int32 | IsUint8Type | Returns true if the underlying object to which the iterator is bound is any <uint8> type. |
| int32 | IsVectorType | Returns true if the underlying object to which the iterator is bound is any vector type. |
| int32 | Validate | Returns true if the iterator has been successfully bound to an object. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| uint32 | Components | Sets or gets the number of components. An iterator represents the start of a span of elements, such as floats, of a specific length. For example: an itertor may represent the start or end of a span of 32 floats. This value allows you to provide hints about the periodicity of the data, such as whether the span consists of groups of 1, 2, 3, 4 primtives. |
| uint32 | Position | Sets or gets the position of the iterator in the collection. This can be a 'start' or 'end' position depending on whether the iterator is 'first' or 'last'. You can set this value to a range from 0 up to the count of the underlying object. For set operations, this value is guarded to make sure you cannot set a value that is outside the bounds of the allocation used by object to which the iterator is bound. |