#include <xsi_uv.h>
Class Description
The CUVArray is
an uni-dimensional array of CUV.
The array is zero-based, which means that the first item index
is zero and the larger index is one less that the number of
elements contained in the array.
- See also:
- CUV,
CTriangleVertexRefArray::GetUVArray,
CTriangleRefArray::GetUVArray, Triangle::GetUVArray
List of all
members.
Constructor & Destructor Documentation
Constructs a CUVArray and
optionally initializes the array to a known size.
- Parameters:
-
| in_size |
Size of array, defaults to 0. |
Member Function Documentation
Assignment operator.
- Parameters:
-
| in_array |
constant class object. |
- Returns:
- A reference to this array.
Returns the number of items in this CUVArray
- Returns:
- The number of items in the array.
Adds a CUV at the end of
this array.
- Parameters:
-
| in_item |
New item to be added at the end of the array. |
- Returns:
-
CStatus::OK success
Erases all elements contained in the array.
- Return values:
-
Reallocates memory for the array, preserves its contents if the
new size is larger than existing size.
- Parameters:
-
| in_size |
New size of the array. |
- Returns:
-
CStatus::OK success
-
CStatus::InvalidArgument in_size < 0
| const CUV& operator[] |
( |
LONG |
in_index |
) |
const |
Accessor to elements at a given index. This function can only be
called by constant objects, the returned value is read-only.
- Parameters:
-
| in_index |
index in this zero-based array. The index must be greater or
equal to zero and smaller than the number of element in the array,
otherwise the results are unpredictable. |
- Returns:
- CUV& A
read-only reference to the indexed item.
| CUV& operator[] |
( |
LONG |
in_index |
) |
|
Accessor to elements at a given index.
- Parameters:
-
| in_index |
index in this zero-based array. The index must be greater or
equal to zero and smaller than the number of element in the array,
otherwise the results are unpredictable. |
- Returns:
- CUV& A
reference to the indexed item.
| bool operator== |
( |
const CUVArray & |
in_array |
) |
const |
Equality operator.
- Parameters:
-
- Returns:
- true if in_array contains the same number of elements as this
array and if all members of in_array are equal to the corresponding
one contained in this array.
| bool operator!= |
( |
const CUVArray & |
in_array |
) |
const |
Inequality
- Parameters:
-
- Returns:
- true if one member of in_array is different from the
corresponding members in this array or if the arrays are not of the
same size.
The documentation for this class was generated from the following
file:
