CSLTriangleList Class Reference

This class represents an SI_TriangleList template. More...

#include <TriangleList.h>

Inheritance diagram for CSLTriangleList:

CSLTemplate CSIBCNode List of all members.

Public Types
typedef CSLArrayProxy< SLTriangle,
SI_Int, 3 > 		 CSLTriangleArray

Public Member Functions
SI_Int  GetTriangleCount ()
SI_Int *  GetVertexIndicesPtr ()
CSLTriangleArray *  GetVertexIndices ()
CSLTriangleArray *  CreateNormalIndices ()
CSLTriangleArray *  GetNormalIndices ()
SI_Int *  GetNormalIndicesPtr ()
SI_Error  DestroyNormalIndices ()
CSLTriangleArray *  CreateColorIndices ()
CSLTriangleArray *  GetColorIndices ()
SI_Int *  GetColorIndicesPtr ()
SI_Error  DestroyColorIndices ()
CSLTriangleArray *  AddUVArray ()
SI_Int  GetUVArrayCount ()
SI_Int *  GetUVIndicesPtr (SI_Int in_nId)
CSLTriangleArray *  GetUVIndices (SI_Int in_nId)
SI_Error  RemoveUVArray ()
SI_Error  ClearUVArrays ()
CSLBaseMaterial *  GetMaterial ()
SI_Void  SetMaterial (CSLBaseMaterial *in_pNewMaterial)
virtual ETemplateType  Type ()
virtual SI_Error  Synchronize ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)

Detailed Description

This class represents an SI_TriangleList template.

Describes a list of triangles (see the SI_TriangleList template reference). It may also contain information about normals, UV coordinates and color.

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

To get the number of triangles in the list, use GetTriangleCount().
See also:
CSLPolygonList

CSLTriStripList

Member Typedef Documentation

typedef CSLArrayProxy<SLTriangle, SI_Int, 3> CSLTriangleArray

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

Member Function Documentation

SI_Int GetTriangleCount (  )  [inline]

Returns the number of triangles in this list.

Returns:
Number of triangles

SI_Int* GetVertexIndicesPtr (  )  [inline]

Returns an array of SI_Int containing the vertex index list.

Returns:
Array of SI_Int

CSLTriangleArray* GetVertexIndices (  )  [inline]

Returns the vertex indices array proxy.

Returns:
Pointer to an array proxy of vertex indices.

CSLTriangleArray* CreateNormalIndices (  ) 

Creates a normal indices array.

Returns:
Pointer to the newly created array.

CSLTriangleArray* 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.

CSLTriangleArray* CreateColorIndices (  ) 

Creates a color indices array.

Returns:
Pointer to the newly created array.

CSLTriangleArray* 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.

CSLTriangleArray* AddUVArray (  ) 

Creates a new UV indices array.

Returns:
Pointer to the newly created array.

SI_Int GetUVArrayCount (  ) 

Returns the number of texture coordinate arrays.

Returns:
Number of UV arrays.

SI_Int* GetUVIndicesPtr ( SI_Int  in_nId  ) 

Returns an array of SI_Int containing the UV index list.

Parameters:
[in]  in_nId  Identification of the UV index list to retrieve.
Returns:
Array of SI_Int

CSLTriangleArray* GetUVIndices ( 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 (  ) 

Removes the last UV indices array.

Returns:
Error code.

SI_Error ClearUVArrays (  ) 

Removes all UV indices array.

Returns:
Error code.

CSLBaseMaterial* GetMaterial (  )  [inline]

Returns the material object of the triangle list.

Returns:
Texture projection name.

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  )  [inline]

Changes the material object of the triangle list.

Parameters:
[in]  in_pNewMaterial  New material object.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_TRIANGLE_LIST  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.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns a proxy to the specified parameter.

Parameters:
[in]  in_szName  Name of the parameter
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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