CSLXSIMesh Class Reference

This class represents an XSI_Mesh template. More...

#include <XSIMesh.h>

Inheritance diagram for CSLXSIMesh:

CSLXSIGeometry CSLPrimitive CSLTemplate CSIBCNode CSLCOLLADAMesh List of all members.

Public Member Functions

SI_Error  ClearXSIPolygonLists ()
SI_Error  ClearXSITriangleLists ()
SI_Error  ClearXSITriangleStripLists ()
SI_Int  GetXSIPolygonListCount ()
SI_Int  GetXSITriangleListCount ()
SI_Int  GetXSITriangleStripListCount ()
CSLXSIPolygonList **  XSIPolygonLists ()
CSLXSITriangleList **  XSITriangleLists ()
CSLXSITriangleStripList **  XSITriangleStripLists ()
virtual CSLXSIPolygonList AddXSIPolygonList ()
virtual CSLXSITriangleList AddXSITriangleList ()
CSLXSITriangleStripList AddXSITriangleStripList ()
SI_Error  RemoveXSIPolygonList (SI_Int l_nIndex)
SI_Error  RemoveXSITriangleList (SI_Int l_nIndex)
SI_Error  RemoveXSITriangleStripList (SI_Int l_nIndex)
SI_Error  RemoveXSIPolygonList (CSLXSIPolygonList *in_pObject)
SI_Error  RemoveXSITriangleList (CSLXSITriangleList *in_pObject)
SI_Error  RemoveXSITriangleStripList (CSLXSITriangleStripList *in_pObject)
CSLXSIShape XSIShape ()
CSLXSIVertexList XSIVertexList ()
CSLXSIShape ConnectXSIShape (CSLXSIShape *)
CSLXSIVertexList ConnectXSIVertexList (CSLXSIVertexList *)
CSLXSIPolygonList ConnectXSIPolygonList (CSLXSIPolygonList *)
CSLXSITriangleList ConnectXSITriangleList (CSLXSITriangleList *)
CSLXSITriangleStripList ConnectXSITriangleStripList (CSLXSITriangleStripList *)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()
virtual SI_Error  Fix ()
virtual CSLAnimatableType ParameterFromName (SI_Char *in_szName)

Detailed Description

This class represents an XSI_Mesh template.

Base class to describe a mesh primitive for dotXSI 5.0+ (see the XSI_Mesh template reference).


Member Function Documentation

SI_Error ClearXSIPolygonLists (  ) 

Clears the entire list of polygon lists

Returns:
Error code

SI_Error ClearXSITriangleLists (  ) 

Clears the entire list of triangle lists

Returns:
Error code

SI_Error ClearXSITriangleStripLists (  ) 

Clears the entire list of triangle strip lists

Returns:
Error code

SI_Int GetXSIPolygonListCount (  ) 

Returns the number of polygon lists for this mesh

Returns:
Number of polygon lists

SI_Int GetXSITriangleListCount (  ) 

Returns the number of triangle lists for this mesh

Returns:
Number of triangle lists

SI_Int GetXSITriangleStripListCount (  ) 

Returns the number of triangle strip lists for this mesh

Returns:
Number of triangle strip lists

CSLXSIPolygonList** XSIPolygonLists (  ) 

Returns the list of polygon lists used by this mesh

Returns:
A list of CSLXSIPolygonList

CSLXSITriangleList** XSITriangleLists (  ) 

Returns the list of triangle lists used by this mesh

Returns:
A list of CSLXSITriangleList

CSLXSITriangleStripList** XSITriangleStripLists (  ) 

Returns the list of triangle strip lists used by this mesh

Returns:
A list of CSLXSITriangleStripList

virtual CSLXSIPolygonList* AddXSIPolygonList (  )  [virtual]

Adds a new polygon list to the mesh.

Returns:
Pointer to the newly created polygon list object.

Reimplemented in CSLCOLLADAMesh.

virtual CSLXSITriangleList* AddXSITriangleList (  )  [virtual]

Adds a new triangle list to the mesh.

Returns:
Pointer to the newly created triangle list object.

Reimplemented in CSLCOLLADAMesh.

CSLXSITriangleStripList* AddXSITriangleStripList (  ) 

Adds a new triangle strip list to the mesh.

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

SI_Error RemoveXSIPolygonList ( 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 RemoveXSITriangleList ( 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 RemoveXSITriangleStripList ( 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 RemoveXSIPolygonList ( CSLXSIPolygonList 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 RemoveXSITriangleList ( CSLXSITriangleList 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 RemoveXSITriangleStripList ( CSLXSITriangleStripList 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.

CSLXSIShape* XSIShape (  )  [inline]

Returns the shape object of the mesh.

Returns:
Pointer to a shape object.

CSLXSIVertexList* XSIVertexList (  )  [inline]

Returns the vertex list object of the mesh.

Returns:
Pointer to a vertex list object.

CSLXSIShape* ConnectXSIShape ( CSLXSIShape  ) 

Connects a shape

Returns:
The connected shape

CSLXSIVertexList* ConnectXSIVertexList ( CSLXSIVertexList  ) 

Connects a vertex list

Returns:
The connected vertex list

CSLXSIPolygonList* ConnectXSIPolygonList ( CSLXSIPolygonList  ) 

Connects a polygon list

Returns:
The connected polygon list

CSLXSITriangleList* ConnectXSITriangleList ( CSLXSITriangleList  ) 

Connects a triangle list

Returns:
The connected triangle list

CSLXSITriangleStripList* ConnectXSITriangleStripList ( CSLXSITriangleStripList  ) 

Connects a triangle strip list

Returns:
The connected triangle strip list

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this Softimage mesh instance with its IO layer representation

Returns:
Error code.

Reimplemented from CSLXSIGeometry.

Reimplemented in CSLCOLLADAMesh.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_MESH  The type of this template

Implements CSLTemplate.

virtual SI_Error Fix (  )  [virtual]

Cleans invalid data from the template.

Returns:
Error code

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADAMesh.

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 CSLXSIGeometry.


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