CSLFXTree Class Reference

#include <FXTree.h>

Inheritance diagram for CSLFXTree:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLFXTree (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLFXTree ()
  Destructor.
SI_Error  Synchronize ()
ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
CSLFXOperator *  AddFXOperator ()
SI_Error  RemoveFXOperator (SI_Int in_nIndex)
SI_Error  RemoveFXOperator (CSLFXOperator *in_pToRemove)
SI_Error  ClearFXOperators ()
CSLFXOperator *  ConnectFXOperator (CSLFXOperator *in_pToConnect)
CSLFXOperator **  GetFXOperatorList ()
SI_Int  GetFXOperatorCount ()
virtual CSLFXOperator *  FindFXOperator (SI_Char *in_szName)

Detailed Description

This class represents an XSI_FXTree template.

Representation of a Softimage Illusion (FX) Tree (see the XSI_FXTree template reference)

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Refered template
Returns:
an instance of CSLFXTree

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

Commits semantic layer data

Returns:
Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_FXTREE  The type of this template

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns a parameter handle by name

Parameters:
[in]  in_szName  the name of the parameter to get
Returns:
the found parameter

Reimplemented from CSLTemplate.

CSLFXOperator* AddFXOperator (  ) 

Adds a FXOperator to the FXOperator list

Returns:
Pointer to the newly added FXOperator

SI_Error RemoveFXOperator ( SI_Int  in_nIndex  ) 

Removes a FXOperator from the FXOperator list

Parameters:
[in]  in_nIndex  Index of the FXOperator to remove
Returns:
Whether or not the FXOperator could be removed

SI_Error RemoveFXOperator ( CSLFXOperator *  in_pToRemove  ) 

Removes a FXOperator from the FXOperator list

Parameters:
[in]  in_pToRemove  Pointer to the FXOperator to remove
Returns:
Whether or not the FXOperator could be removed

SI_Error ClearFXOperators (  ) 

Removes all operators from the FXOperator list

Returns:
Whether or not the list could be cleared

CSLFXOperator* ConnectFXOperator ( CSLFXOperator *  in_pToConnect  ) 

Adds an exisiting FXOperator to the FXOperator list

Parameters:
[in]  in_pToConnect  Pointer to the FXOperator to add
Returns:
The added FXOperator or null if it already exists in the list

CSLFXOperator** GetFXOperatorList (  ) 

Returns a pointer to the internally-stored FXOperator pointer list

Returns:
Pointer to the list

SI_Int GetFXOperatorCount (  ) 

Returns the total number of FXOperators

Returns:
Number of FXOperators

virtual CSLFXOperator* FindFXOperator ( SI_Char *  in_szName  )  [virtual]

Searches for a FXOperator by name

Parameters:
[in]  in_szName  Name of the FXOperator to look for
Returns:
Pointer to the found FXOperator or null if not found

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