CSLTriangleStripList Class Reference

#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

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 (  ) 

Add a new triangle strip to the list.

Returns:
CSLTriangleStrip* Pointer to the newly created triangle strip object.

SI_Int GetTriangleStripCount (  ) 

Returns the number of triangle strips in this list

Returns:
SI_Int Number of triangle strips

CSLTriangleStrip** TriangleStrips (  ) 

Returns the list of triangle strips in the object.

Returns:
CSLTriangleStrip** A list of pointers to triangle strips objects.

SI_Error RemoveTriangleStrip ( SI_Int  in_nIndex  ) 

Remove a single triangle strip from the list.

Parameters:
SI_Int  Index of the triangle strip to remove.
Returns:
SI_Error Error code.

SI_Error RemoveTriangleStrip ( CSLTriangleStrip *  in_pTriangleStrip  ) 

Remove a single triangle strip from the list.

Parameters:
CSLTriangleStripList*  Pointer to the triangle strip to remove.
Returns:
SI_Error Error code.

SI_Error ClearTriangleStrips (  ) 

Clears the entire list of triangle strips

Returns:
SI_Error Error code

CSLBaseMaterial* GetMaterial (  )  [inline]

Return the material object of the triangle strip list.

Returns:
CSLBaseMaterial* Texture projection name.

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  )  [inline]

Change the material object of the triangle strip 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: