CSLShape Class Reference

This class represents an SI_Shape template. More...

#include <Shape.h>

Inheritance diagram for CSLShape:

CSLBaseShape CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLShape (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, EShapeType in_Type)
virtual  ~CSLShape ()
CSLVector2DArray *  CreateUVCoords ()
CSLIndexedVector2DArray *  CreateIndexedUVCoords ()
SI_Int  GetUVCoordCount ()
CSLVector2DArray *  GetUVCoordList ()
CSIBCVector2D *  GetUVCoordListPtr ()
CSLIndexedVector2DArray *  GetIndexedUVCoordList ()
SLIndexedVector2D *  GetIndexedUVCoordListPtr ()
SI_Error  DestroyUVCoords ()
virtual ETemplateType  Type ()
virtual SI_Error  Synchronize ()

Detailed Description

This class represents an SI_Shape template.

Describes a mesh shape (see the SI_Shape template reference). The CSLShape holds the mesh's vertex positions, normals, texture coordinates and color information.

Constructor & Destructor Documentation

CSLShape ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate,
EShapeType  in_Type  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Referred template
[in]  in_Type  the type of shape to construct
Returns:
an instance of CSLShape

virtual ~CSLShape (  )  [virtual]

Destructor

Member Function Documentation

CSLVector2DArray* CreateUVCoords (  ) 

Creates a texture coordinates array.

Returns:
Pointer to the newly created array.

CSLIndexedVector2DArray* CreateIndexedUVCoords (  ) 

Creates an indexed texture coordinates array.

Returns:
Pointer to the newly created indexed array.

SI_Int GetUVCoordCount (  ) 

Returns the number of texture coordinates.

Returns:
Number of UV.

CSLVector2DArray* GetUVCoordList (  ) 

Returns the texture coordinate array proxy.

Returns:
Pointer to an array proxy of UV.

CSIBCVector2D* GetUVCoordListPtr (  ) 

Returns an array of CSIBCVector2D that describes the texture coordinates for this mesh.

Returns:
Array of texture coordinates

CSLIndexedVector2DArray* GetIndexedUVCoordList (  ) 

Returns the indexed texture coordinate array proxy.

Returns:
Pointer to an array proxy of indexed UV.

SLIndexedVector2D* GetIndexedUVCoordListPtr (  ) 

Returns an array of SLIndexedVector2D that describes the indexed texture coordinates for this mesh.

Returns:
Array of indexed texture coordinates

SI_Error DestroyUVCoords (  ) 

Destroys the texture coordinates array.

Returns:
Error code.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the template type

Return values:
CSLTemplate::SI_SHAPE  the template type of the shape surface

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this shape instance with its IO layer representation

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

Reimplemented from CSLBaseShape.

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