CSLTriangleStrip Class Reference

This class represents an SI_TriStrip template. More...

#include <TriangleStrip.h>

Inheritance diagram for CSLTriangleStrip:

CSLTemplate CSIBCNode List of all members.

Public Types

typedef CSLArrayProxy< SI_Int,
SI_Int, 1 > 
CSLIntArray

Public Member Functions

SI_Int  GetVertexCount ()
CSLIntArray GetVertexIndices ()
SI_Int *  GetVertexIndicesPtr ()
CSLIntArray CreateNormalIndices ()
CSLIntArray GetNormalIndices ()
SI_Int *  GetNormalIndicesPtr ()
SI_Error  DestroyNormalIndices ()
CSLIntArray CreateColorIndices ()
CSLIntArray GetColorIndices ()
SI_Int *  GetColorIndicesPtr ()
SI_Error  DestroyColorIndices ()
CSLIntArray AddUVArray ()
CSLIntArray GetUVIndices (SI_Int in_nId)
SI_Int *  GetUVIndicesPtr (SI_Int in_nId)
SI_Error  RemoveUVArray ()
SI_Error  ClearUVArrays ()
SI_Int  GetUVArrayCount ()
virtual ETemplateType  Type ()
virtual SI_Error  Synchronize ()

Detailed Description

This class represents an SI_TriStrip template.

Describes a triangle strip (see the SI_TriStrip template reference). The triangles in this list can have normals, UV and color information as well.

Tip:
You can use the GetNormalIndices(), GetUVIndices() and GetColorIndices() to see whether the return value is non-NULL.
See also:
CSLTriangleStripList

CSLTriangleList

CSLPolygonList


Member Typedef Documentation

typedef CSLArrayProxy<SI_Int, SI_Int, 1> CSLIntArray

Proxy class that allows modifying a list of SI_Int like an array.


Member Function Documentation

SI_Int GetVertexCount (  )  [inline]

Returns the number of vertices in this strip.

Returns:
Number of vertices.

CSLIntArray* GetVertexIndices (  )  [inline]

Returns the vertex indices array proxy.

Returns:
Pointer to an array proxy of vertex indices.

SI_Int* GetVertexIndicesPtr (  )  [inline]

Returns an array of SI_Int containing the vertex index list.

Returns:
Array of SI_Int

CSLIntArray* CreateNormalIndices (  ) 

Creates a normal indices array.

Returns:
Pointer to the newly created array.

CSLIntArray* GetNormalIndices (  )  [inline]

Returns the normal indices array proxy.

Returns:
Pointer to an array proxy of normal indices.

SI_Int* GetNormalIndicesPtr (  ) 

Returns an array of SI_Int containing the normal index list.

Returns:
Array of SI_Int

SI_Error DestroyNormalIndices (  ) 

Destroys the normal indices array.

Returns:
Error code.

CSLIntArray* CreateColorIndices (  ) 

Creates a color indices array.

Returns:
Pointer to the newly created array.

CSLIntArray* GetColorIndices (  )  [inline]

Returns the color indices array proxy.

Returns:
Pointer to an array proxy of color indices.

SI_Int* GetColorIndicesPtr (  ) 

Returns an array of SI_Int containing the color index list.

Returns:
Array of SI_Int

SI_Error DestroyColorIndices (  ) 

Destroys the color indices array.

Returns:
Error code.

CSLIntArray* AddUVArray (  ) 

Creates a new UV indices array.

Returns:
Pointer to the newly created array.

CSLIntArray* GetUVIndices ( SI_Int  in_nId  ) 

Returns the number of texture coordinate arrays.

Parameters:
[in]  in_nId  Number of UV arrays.
Returns:
Pointer to the newly created array.

SI_Int* GetUVIndicesPtr ( SI_Int  in_nId  ) 

Returns the UV indices array proxy.

Parameters:
[in]  in_nId  Identification of the UV array to retrieve.
Returns:
Pointer to an array proxy of UV indices.

SI_Error RemoveUVArray (  ) 

Returns an array of SI_Int containing the UV index list.

Returns:
Array of SI_Int

SI_Error ClearUVArrays (  ) 

Removes the last UV indices array.

Returns:
Error code.

SI_Int GetUVArrayCount (  ) 

Removes all UV indices array.

Returns:
Error code.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_TRIANGLE_STRIP  Template type

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes to ensure that the animated parameter is up to date.

Returns:
Error code

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following file: