CSLXSITriangleList Class Reference

Describes a list of triangles for dotXSI 5.0+. More...

#include <XSITriangleList.h>

Inheritance diagram for CSLXSITriangleList:

CSLXSISubComponentList CSLTemplate CSIBCNode CSLCOLLADATriangleList List of all members.

Public Member Functions
  CSLXSITriangleList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSITriangleList ()
virtual ETemplateType  Type ()
CSLBaseMaterial *  GetMaterial ()
CSIBCString  GetMaterialName ()
SI_Void  SetMaterial (CSLBaseMaterial *in_pNewMaterial)
SI_Void  SetMaterialName (const CSIBCString &in_szNewMaterialName)
CSLIntArray *  GetVertexIndices ()
SI_Int  GetTriangleCount ()
virtual SI_Error  SetCount (SI_Int)
virtual SI_Error  Synchronize ()

Detailed Description

Describes a list of triangles for dotXSI 5.0+.

The CSLXSITriangleList class describes a list of triangles The polynodes in this list can have N number of attibutes like vertex, normals, UV and color information.

To find out, you may use GetVertexIndices() to get the mendatory vertex index attributes and the parent class (CSLXSISubComponentList) functionality to get the other generic attributes index.

To get the number of triangles in the list, use GetTriangleCount().

Constructor & Destructor Documentation

CSLXSITriangleList ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template
Returns:
an instance of CSLXSITriangleList

virtual ~CSLXSITriangleList (  )  [virtual]

Destructor

Member Function Documentation

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template (XSI_TRIANGLE_LIST)

Returns:
CSLTemplate::ETemplateType The type of this template (XSI_TRIANGLE_LIST)

Implements CSLTemplate.

CSLBaseMaterial* GetMaterial (  )  [inline]

Return the material object of the triangle list.

Returns:
CSLBaseMaterial* Material object.

CSIBCString GetMaterialName (  ) 

Return the material object name of the triangle list or an empty string if there's none.

Returns:
CSIBCString Material object name.

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  ) 

Change the material object of the triangle list.

Parameters:
CSLBaseMaterial*  New material object.
Returns:
None

SI_Void SetMaterialName ( const CSIBCString &  in_szNewMaterialName  ) 

Change the material object name of the triangle list. Should ONLY be called if we don't export the material.

Parameters:
const  CSIBCString& New material object name.
Returns:
None

CSLIntArray* GetVertexIndices (  ) 

Get the polynode vertex indices array.

Returns:
CSLIntArray Array of polynode vertex indices.

SI_Int GetTriangleCount (  ) 

Get the number of triangle.

Returns:
SI_Int Number of triangle.

virtual SI_Error SetCount ( SI_Int   )  [virtual]

Set the number of polynode in this triangle list.

Returns:
SI_Error Error code.

Reimplemented from CSLXSISubComponentList.

virtual SI_Error Synchronize (  )  [virtual]

Commit the current template information

Returns:
SI_Error Whether or not the commit was successful

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADATriangleList.

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