CSLMesh Class Reference

Describes a mesh primitive (see the SI_Mesh template reference). More...

#include <Mesh.h>

Inheritance diagram for CSLMesh:

CSLGeometry CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Member Functions
SI_Error  ClearPolygonLists ()
SI_Error  ClearTriangleLists ()
SI_Error  ClearTriangleStripLists ()
SI_Int  GetPolygonListCount ()
SI_Int  GetTriangleListCount ()
SI_Int  GetTriangleStripListCount ()
CSLPolygonList **  PolygonLists ()
CSLTriangleList **  TriangleLists ()
CSLTriangleStripList **  TriangleStripLists ()
CSLPolygonList *  AddPolygonList ()
CSLTriangleList *  AddTriangleList ()
CSLTriangleStripList *  AddTriangleStripList ()
SI_Error  RemovePolygonList (SI_Int l_nIndex)
SI_Error  RemoveTriangleList (SI_Int l_nIndex)
SI_Error  RemoveTriangleStripList (SI_Int l_nIndex)
SI_Error  RemovePolygonList (CSLPolygonList *in_pObject)
SI_Error  RemoveTriangleList (CSLTriangleList *in_pObject)
SI_Error  RemoveTriangleStripList (CSLTriangleStripList *in_pObject)
CSLBaseShape *  Shape ()
virtual SI_Error  Synchronize ()
virtual SI_Error  Fix ()
virtual ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)

Detailed Description

Describes a mesh primitive (see the SI_Mesh template reference).

The CSLMesh class is used to manipulate the polygon, tiangle or tri-strip lists.

Member Function Documentation

SI_Error ClearPolygonLists (  ) 

Clears the entire list of polygon lists

Returns:
Error code

SI_Error ClearTriangleLists (  ) 

Clears the entire list of triangle lists

Returns:
Error code

SI_Error ClearTriangleStripLists (  ) 

Clears the entire list of triangle strip lists

Returns:
Error code

SI_Int GetPolygonListCount (  ) 

Returns the number of polygon lists for this mesh

Returns:
Number of polygon lists

SI_Int GetTriangleListCount (  ) 

Returns the number of triangle lists for this mesh

Returns:
Number of triangle lists

SI_Int GetTriangleStripListCount (  ) 

Returns the number of triangle strip lists for this mesh

Returns:
Number of triangle strip lists

CSLPolygonList** PolygonLists (  ) 

Returns the list of polygon lists used by this mesh

Returns:
A list of CSLPolygonList

CSLTriangleList** TriangleLists (  ) 

Returns the list of triangle lists used by this mesh

Returns:
A list of CSLTriangleList

CSLTriangleStripList** TriangleStripLists (  ) 

Returns the list of triangle strip lists used by this mesh

Returns:
A list of CSLTriangleStripList

CSLPolygonList* AddPolygonList (  ) 

Adds a new polygon list to the mesh.

Returns:
Pointer to the newly created polygon list object.

CSLTriangleList* AddTriangleList (  ) 

Adds a new triangle list to the mesh.

Returns:
Pointer to the newly created triangle list object.

CSLTriangleStripList* AddTriangleStripList (  ) 

Adds a new triangle strip list to the mesh.

Returns:
Pointer to the newly created triangle strip list object.

SI_Error RemovePolygonList ( SI_Int  l_nIndex  ) 

Removes a single polygon list from the mesh.

Parameters:
[in]  l_nIndex  Index of the polygon list to remove.
Returns:
Error code.

SI_Error RemoveTriangleList ( SI_Int  l_nIndex  ) 

Removes a single triangle list from the mesh.

Parameters:
[in]  l_nIndex  Index of the triangle list to remove.
Returns:
Error code.

SI_Error RemoveTriangleStripList ( SI_Int  l_nIndex  ) 

Removes a single triangle strip list from the mesh.

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

SI_Error RemovePolygonList ( CSLPolygonList *  in_pObject  ) 

Removes a single polygon list from the mesh.

Parameters:
[in]  in_pObject  Pointer to the polygon list to remove.
Returns:
Error code.

SI_Error RemoveTriangleList ( CSLTriangleList *  in_pObject  ) 

Removes a single triangle list from the mesh.

Parameters:
[in]  in_pObject  Pointer to the triangle list to remove.
Returns:
Error code.

SI_Error RemoveTriangleStripList ( CSLTriangleStripList *  in_pObject  ) 

Removes a single triangle strip list from the mesh.

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

CSLBaseShape* Shape (  )  [inline]

Returns the shape object of the mesh.

Returns:
Pointer to a shape object.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this geometry instance with its IO layer representation

Return values:
SI_Error::SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLGeometry.

virtual SI_Error Fix (  )  [virtual]

Cleans invalid data from the template.

Returns:
Error code

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_MESH  Template type

Implements CSLTemplate.

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

Returns a handle on one of this geometry's parameters by using its name

Parameters:
[in]  in_szName  the name of the parameter to get the handle from
Returns:
the handle to the parameter

Reimplemented from CSLGeometry.

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