CSLCOLLADAEffectLibrary Class Reference

COLLADA Effect Library class definition. More...

#include <COLLADAEffectLibrary.h>

Inheritance diagram for CSLCOLLADAEffectLibrary:

CSLTemplate CSIBCNode List of all members.

Public Member Functions

CSLCOLLADAFX *  AddEffect ()
SI_Error  ClearEffects ()
CSLCOLLADAFX **  GetEffectList ()
SI_Int  GetEffectCount ()
SI_Error  RemoveEffect (SI_Int in_nIndex)
SI_Error  RemoveEffect (CSLCOLLADAFX *in_pEffect)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

COLLADA Effect Library class definition.


Member Function Documentation

CSLCOLLADAFX* AddEffect (  ) 

Adds a new Effect to the Effect library.

Returns:
Pointer to the newly created Effect object.

SI_Error ClearEffects (  ) 

Removes all Effects from the Effect library.

Returns:
Error code.

CSLCOLLADAFX** GetEffectList (  ) 

Returns an array of all Effects in the library.

Returns:
Array of pointers to Effect objects.

SI_Int GetEffectCount (  ) 

Returns the number of Effects in the library.

Returns:
Number of Effects.

SI_Error RemoveEffect ( SI_Int  in_nIndex  ) 

Removes a single Effect from the library.

Parameters:
[in]  in_nIndex  Index of the Effect to remove.
Returns:
Error code.

SI_Error RemoveEffect ( CSLCOLLADAFX *  in_pEffect  ) 

Removes a single Effect from the library.

Parameters:
[in]  in_pEffect  Pointer to the Effect to remove.
Returns:
Error code.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes to ensure that the animated parameter is up to date.

Returns:
Error code

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [virtual]

Returns the type of this template

Return values:
CSLTemplate::COLLADA_EFFECT_LIBRARY  Template type

Implements CSLTemplate.


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