Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLFXTree Class Reference

Representation of an XSI FX Tree. More...

#include <FXTree.h>

Inheritance diagram for CSLFXTree::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Representation of an XSI FX Tree.


Constructor & Destructor Documentation

CSLFXTree::CSLFXTree CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

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


Member Function Documentation

CSLFXOperator * CSLFXTree::AddFXOperator  
 

Add a FXOperator to the FXOperator list

Returns:
CSLFXOperator Pointer to the newly added FXOperator

SI_Error CSLFXTree::ClearFXOperators  
 

Removes all operators from the FXOperator list

Returns:
SI_Error Whether or not the list could be cleared

CSLFXOperator * CSLFXTree::ConnectFXOperator CSLFXOperator   in_pNewFXOperator
 

Adds an exisiting FXOperator to the FXOperator list

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

CSLFXOperator * CSLFXTree::FindFXOperator SI_Char *    in_szFXOperatorName [virtual]
 

Searches for a FXOperator by name

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

SI_Int CSLFXTree::GetFXOperatorCount  
 

Gets the total number of FXOperators

Returns:
SI_Int Number of FXOperators

CSLFXOperator ** CSLFXTree::GetFXOperatorList  
 

Gets a pointer to the internally-stored FXOperator pointer list

Returns:
CSLFXOperator Pointer to the list

CSLAnimatableType * CSLFXTree::ParameterFromName SI_Char *    in_szName [virtual]
 

Gets a parameter handle by name

Parameters:
in_szName  the name of the parameter to get
Returns:
CSLAnimatableType* the found parameter

Reimplemented from CSLTemplate.

SI_Error CSLFXTree::RemoveFXOperator CSLFXOperator   in_pToRemove
 

Removes a FXOperator from the FXOperator list

Parameters:
in_pToRemove  Pointer to the FXOperator to remove
Returns:
SI_Error Whether or not the FXOperator could be removed

SI_Error CSLFXTree::RemoveFXOperator SI_Int    in_nIndex
 

Removes a FXOperator from the FXOperator list

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

SI_Error CSLFXTree::Synchronize   [virtual]
 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLFXTree::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_FXTREE

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.