CSLEnvelope Class Reference

Describes an envelope. 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

Describes an envelope.

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_pScene  Pointer to the scene containing the envelope
in_pModel  Pointer to the model containing the envelope
in_pTemplate  Pointer to the CdotXSITemplate containing the envelope
Returns:
an instance of CSLEnvelope

virtual ~CSLEnvelope (  )  [virtual]

Destructor

Member Function Documentation

CSLModel* GetDeformer (  ) 

Return the model that deforms this envelope.

Returns:
CSLModel* Pointer to the deformer model.

SI_Void SetDeformer ( CSLModel *  in_pNewDeformer  ) 

Change the model deforming the envelope.

Parameters:
in_pNewDeformer  New deforming model object.
Returns:
None

CSLModel* GetEnvelope (  ) 

Return the model that represent this envelope.

Returns:
CSLModel* Pointer to the enveloped model.

SI_Void SetEnvelope ( CSLModel *  in_pNewEnvelope  ) 

Change the model represented by the envelope.

Parameters:
in_pNewEnvelope  New envelope model object.
Returns:
None

SI_Int GetVertexWeightCount (  ) 

Return the number of vertex weights.

Returns:
SI_Int Number of vertex weights.

CSLVertexWeightArray* GetVertexWeightList (  ) 

Return the vertex weights in an array proxy.

Returns:
CSLVertexWeightArray* Pointer to an array proxy of vertex weights.

SLVertexWeight* GetVertexWeightListPtr (  ) 

Returns an array of SLVertexWeight containing the vertex weights.

Returns:
SLVertexWeight* Array of vertex weights.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this envelope instance with its IO layer representation

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

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADAEnvelope.

virtual ETemplateType Type (  )  [inline, virtual]

Get the template type

Returns:
ETemplateType the template type of the envelope

Implements CSLTemplate.

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