CSLTriangleStripList Class Reference

This class represents an SI_TriStripList template. More...

#include <TriangleStripList.h>

Inheritance diagram for CSLTriangleStripList:

CSLTemplate CSIBCNode List of all members.

Public Member Functions

CSLTriangleStrip AddTriangleStrip ()
SI_Int  GetTriangleStripCount ()
CSLTriangleStrip **  TriangleStrips ()
SI_Error  RemoveTriangleStrip (SI_Int in_nIndex)
SI_Error  RemoveTriangleStrip (CSLTriangleStrip *in_pTriangleStrip)
SI_Error  ClearTriangleStrips ()
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_TriStripList template.

Describes a list of CSLTriangleStrips (see the SI_TriStripList template reference). A mesh can be made up of 3 types of polygons. N-sided polygons (CSLPolygonList), Triangles (CSLTriangleList) and Tri-Strips (CSLTriangleStrip). The CSLTriangleStripList is simply a container of CSLTriangleStrips that share the same material. To access the triangle strips from a CSLMesh object (or to add new ones), you should use this class instead of working with the CSLTriangleStrip class directly.


Member Function Documentation

CSLTriangleStrip* AddTriangleStrip (  ) 

Adds a new triangle strip to the list.

Returns:
Pointer to the newly created triangle strip object.

SI_Int GetTriangleStripCount (  ) 

Returns the number of triangle strips in this list

Returns:
Number of triangle strips

CSLTriangleStrip** TriangleStrips (  ) 

Returns the list of triangle strips in the object.

Returns:
A list of pointers to triangle strips objects.

SI_Error RemoveTriangleStrip ( SI_Int  in_nIndex  ) 

Removes a single triangle strip from the list.

Parameters:
[in]  in_nIndex  Index of the triangle strip to remove.
Returns:
Error code.

SI_Error RemoveTriangleStrip ( CSLTriangleStrip in_pTriangleStrip  ) 

Removes a single triangle strip from the list.

Parameters:
[in]  in_pTriangleStrip  Pointer to the triangle strip to remove.
Returns:
Error code.

SI_Error ClearTriangleStrips (  ) 

Clears the entire list of triangle strips

Returns:
Error code

CSLBaseMaterial* GetMaterial (  )  [inline]

Returns the material object of the triangle strip list.

Returns:
Texture projection name.

SI_Void SetMaterial ( CSLBaseMaterial in_pNewMaterial  )  [inline]

Changes the material object of the triangle strip list.

Parameters:
[in]  in_pNewMaterial  New material object.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template.

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