CSLEnvelopeList Class Reference

#include <EnvelopeList.h>

Inheritance diagram for CSLEnvelopeList:

CSLTemplate CSIBCNode CSLCOLLADAEnvelopeList List of all members.

Public Member Functions
  CSLEnvelopeList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLEnvelopeList ()
virtual CSLEnvelope *  AddEnvelope ()
SI_Int  GetEnvelopeCount ()
CSLEnvelope **  Envelopes ()
SI_Error  RemoveEnvelope (SI_Int in_nIndex)
SI_Error  RemoveEnvelope (CSLEnvelope *in_pEnvelope)
SI_Error  ClearEnvelopes ()
CSLEnvelope *  ConnectEnvelope (CSLEnvelope *in_pNewEnvelope)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

Describes the envelope list (see the SI_EnvelopeList template reference).

Constructor & Destructor Documentation

CSLEnvelopeList ( 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 ~CSLEnvelopeList (  )  [virtual]

Destructor

Member Function Documentation

virtual CSLEnvelope* AddEnvelope (  )  [virtual]

Add a new envelope to the list.

Returns:
CSLEnvelope* Pointer to the newly created envelope object.

Reimplemented in CSLCOLLADAEnvelopeList.

SI_Int GetEnvelopeCount (  ) 

Return the number of envelopes in the list.

Returns:
SI_Int Number of envelopes.

CSLEnvelope** Envelopes (  ) 

Return an array of all envelopes in the list.

Returns:
CSLEnvelope** Array of pointers to envelope objects.

SI_Error RemoveEnvelope ( SI_Int  in_nIndex  ) 

Remove a single envelope from the list.

Parameters:
in_nIndex  Index of the envelope to remove.
Returns:
SI_Error Error code.

SI_Error RemoveEnvelope ( CSLEnvelope *  in_pEnvelope  ) 

Remove a single envelope from the list.

Parameters:
in_pEnvelope  Pointer to the envelope to remove.
Returns:
SI_Error Error code.

SI_Error ClearEnvelopes (  ) 

Remove all envelopes from the list.

Returns:
SI_Error Error code.

CSLEnvelope* ConnectEnvelope ( CSLEnvelope *  in_pNewEnvelope  ) 

Connects a new envelope

Parameters:
in_pNewEnvelope  the envelope to connect
Returns:
CSLEnvelope the connected envelope

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this envelope list instance with its IO layer representation

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

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADAEnvelopeList.

virtual ETemplateType Type (  )  [inline, virtual]

Get the template type

Returns:
ETemplateType the template type of the envelope list

Implements CSLTemplate.

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