CSLTriangleList Class Reference

#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

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:
SI_Int Number of triangles

SI_Int* GetVertexIndicesPtr (  )  [inline]

Returns an array of SI_Int containing the vertex index list.

Returns:
SI_Int* Array of SI_Int

CSLTriangleArray* GetVertexIndices (  )  [inline]

Return the vertex indices array proxy.

Returns:
CSLTriangleArray* Pointer to an array proxy of vertex indices.

CSLTriangleArray* CreateNormalIndices (  ) 

Create a normal indices array.

Returns:
CSLTriangleArray* Pointer to the newly created array.

CSLTriangleArray* GetNormalIndices (  )  [inline]

Return the normal indices array proxy.

Returns:
CSLTriangleArray* Pointer to an array proxy of normal indices.

SI_Int* GetNormalIndicesPtr (  ) 

Returns an array of SI_Int containing the normal index list.

Returns:
SI_Int* Array of SI_Int

SI_Error DestroyNormalIndices (  ) 

Destroy the normal indices array.

Returns:
SI_Error Error code.

CSLTriangleArray* CreateColorIndices (  ) 

Create a color indices array.

Returns:
CSLTriangleArray* Pointer to the newly created array.

CSLTriangleArray* GetColorIndices (  )  [inline]

Return the color indices array proxy.

Returns:
CSLTriangleArray* Pointer to an array proxy of color indices.

SI_Int* GetColorIndicesPtr (  ) 

Returns an array of SI_Int containing the color index list.

Returns:
SI_Int* Array of SI_Int

SI_Error DestroyColorIndices (  ) 

Destroy the color indices array.

Returns:
SI_Error Error code.

CSLTriangleArray* AddUVArray (  ) 

Create a new UV indices array.

Returns:
CSLTriangleArray* Pointer to the newly created array.

SI_Int GetUVArrayCount (  ) 

Return the number of texture coordinate arrays.

Returns:
SI_Int Number of UV arrays.

SI_Int* GetUVIndicesPtr ( SI_Int  in_nId  ) 

Returns an array of SI_Int containing the UV index list.

Returns:
SI_Int* Array of SI_Int

CSLTriangleArray* GetUVIndices ( SI_Int  in_nId  ) 

Return the UV indices array proxy.

Parameters:
SI_Int  Identification of the UV array to retrieve.
Returns:
CSLTriangleArray* Pointer to an array proxy of UV indices.

SI_Error RemoveUVArray (  ) 

Remove the last UV indices array.

Returns:
SI_Error Error code.

SI_Error ClearUVArrays (  ) 

Remove all UV indices array.

Returns:
SI_Error Error code.

CSLBaseMaterial* GetMaterial (  )  [inline]

Return the material object of the triangle list.

Returns:
CSLBaseMaterial* Texture projection name.

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  )  [inline]

Change the material object of the triangle list.

Parameters:
CSLBaseMaterial*  New material object.
Returns:
None

virtual ETemplateType Type (  )  [inline, virtual]

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronize will ensure that the animated parameter is up to date.

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

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

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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