CSLXSITriangleList Class Reference

This class represents an XSI_TriangleList template. 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

This class represents an XSI_TriangleList template.

Describes a list of triangles for dotXSI 5.0+ (see the XSI_TriangleList template reference). The polynodes in this list can have N number of attibutes like vertex, normals, UV and color information.

Tip:
You can use GetVertexIndices() to get the mandatory vertex index attributes and the parent class (CSLXSISubComponentList) functionality to get the other generic attributes index.

You can use GetTriangleCount() to get the number of triangles in the list.

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  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

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

Implements CSLTemplate.

CSLBaseMaterial* GetMaterial (  )  [inline]

Returns the material object of the triangle list.

Returns:
Material object.

CSIBCString GetMaterialName (  ) 

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

Returns:
Material object name.

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  ) 

Changes the material object of the triangle list.

Parameters:
[in]  in_pNewMaterial  New material object.

SI_Void SetMaterialName ( const CSIBCString &  in_szNewMaterialName  ) 

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

Parameters:
[in]  in_szNewMaterialName  New material object name.

CSLIntArray* GetVertexIndices (  ) 

Returns the polynode vertex indices array.

Returns:
Array of polynode vertex indices.

SI_Int GetTriangleCount (  ) 

Returns the number of triangle.

Returns:
Number of triangle.

virtual SI_Error SetCount ( SI_Int   )  [virtual]

Sets the number of polynode in this triangle list.

Returns:
Error code.

Reimplemented from CSLXSISubComponentList.

virtual SI_Error Synchronize (  )  [virtual]

Commits the current template information

Returns:
Whether or not the commit was successful

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADATriangleList.

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