CSLEnvelope Class Reference

This class represents an SI_Envelope template. More...

#include <Envelope.h>

Inheritance diagram for CSLEnvelope:

CSLTemplate CSIBCNode CSLCOLLADAEnvelope List of all members.

Public Types
typedef CSLArrayProxy< SLVertexWeight,
SI_Float, 2 > 		 CSLVertexWeightArray

Public Member Functions
  CSLEnvelope (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLEnvelope ()
CSLModel *  GetDeformer ()
SI_Void  SetDeformer (CSLModel *in_pNewDeformer)
CSLModel *  GetEnvelope ()
SI_Void  SetEnvelope (CSLModel *in_pNewEnvelope)
SI_Int  GetVertexWeightCount ()
CSLVertexWeightArray *  GetVertexWeightList ()
SLVertexWeight *  GetVertexWeightListPtr ()
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

This class represents an SI_Envelope template.

Describes an envelope (see the SI_Envelope template reference).

Member Typedef Documentation

typedef CSLArrayProxy<SLVertexWeight, SI_Float, 2> CSLVertexWeightArray

Proxy class that allows modifying a list of SLVertexWeight like an array.

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the envelope
[in]  in_pModel  Pointer to the model containing the envelope
[in]  in_pTemplate  Pointer to the CdotXSITemplate containing the envelope
Returns:
an instance of CSLEnvelope

virtual ~CSLEnvelope (  )  [virtual]

Destructor

Member Function Documentation

CSLModel* GetDeformer (  ) 

Returns the model that deforms this envelope.

Returns:
Pointer to the deformer model.

SI_Void SetDeformer ( CSLModel *  in_pNewDeformer  ) 

Changes the model deforming the envelope.

Parameters:
[in]  in_pNewDeformer  New deforming model object.

CSLModel* GetEnvelope (  ) 

Returns the model that represent this envelope.

Returns:
Pointer to the enveloped model.

SI_Void SetEnvelope ( CSLModel *  in_pNewEnvelope  ) 

Changes the model represented by the envelope.

Parameters:
[in]  in_pNewEnvelope  New envelope model object.

SI_Int GetVertexWeightCount (  ) 

Returns the number of vertex weights.

Returns:
Number of vertex weights.

CSLVertexWeightArray* GetVertexWeightList (  ) 

Returns the vertex weights in an array proxy.

Returns:
Pointer to an array proxy of vertex weights.

SLVertexWeight* GetVertexWeightListPtr (  ) 

Returns an array of SLVertexWeight containing the vertex weights.

Returns:
Array of vertex weights.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this envelope instance with its IO layer representation

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

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADAEnvelope.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the template type of the envelope

Returns:
CSLTemplate::SI_ENVELOPE the template type

Implements CSLTemplate.

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