Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLEnvelope Class Reference

Describes an envelope. More...

#include <Envelope.h>

Inheritance diagram for CSLEnvelope::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Describes an envelope.


Member Typedef Documentation

typedef CSLArrayProxy<SLVertexWeight, SI_Float, 2> CSLEnvelope::CSLVertexWeightArray
 

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


Constructor & Destructor Documentation

CSLEnvelope::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

CSLEnvelope::~CSLEnvelope   [virtual]
 

Destructor


Member Function Documentation

CSLModel * CSLEnvelope::GetDeformer  
 

Return the model that deforms this envelope.

Returns:
CSLModel* Pointer to the deformer model.

CSLModel * CSLEnvelope::GetEnvelope  
 

Return the model that represent this envelope.

Returns:
CSLModel* Pointer to the enveloped model.

SI_Int CSLEnvelope::GetVertexWeightCount  
 

Return the number of vertex weights.

Returns:
SI_Int Number of vertex weights.

CSLEnvelope::CSLVertexWeightArray * CSLEnvelope::GetVertexWeightList  
 

Return the vertex weights in an array proxy.

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

SLVertexWeight * CSLEnvelope::GetVertexWeightListPtr  
 

Returns an array of SLVertexWeight containing the vertex weights.

Returns:
SLVertexWeight* Array of vertex weights.

SI_Void CSLEnvelope::SetDeformer CSLModel   in_pNewDeformer
 

Change the model deforming the envelope.

Parameters:
in_pNewDeformer  New deforming model object.
Returns:
None

SI_Void CSLEnvelope::SetEnvelope CSLModel   in_pNewEnvelope
 

Change the model represented by the envelope.

Parameters:
in_pNewEnvelope  New envelope model object.
Returns:
None

SI_Error CSLEnvelope::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.

virtual ETemplateType CSLEnvelope::Type   [inline, virtual]
 

Get the template type

Returns:
ETemplateType the template type of the envelope

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.