Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLFXOperator Class Reference

Representation of an operator in the FX Tree. More...

#include <FXNode.h>

Inheritance diagram for CSLFXOperator::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Representation of an operator in the FX Tree.


Constructor & Destructor Documentation

CSLFXOperator::CSLFXOperator 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 CSLFCOperator


Member Function Documentation

CSLFXOperatorConnection * CSLFXOperator::AddConnectionPoint  
 

Add a connection point to the connection point list

Returns:
CSLFXOperatorConnection* Pointer to the newly added connection point

CSLVariantParameter * CSLFXOperator::AddParameter  
 

Add a parameter to the parameter list

Returns:
CSLParameter Pointer to the newly added parameter

SI_Error CSLFXOperator::ClearConnectionPoints  
 

Removes all connections points from the connection point list

Returns:
SI_Error Whether or not the list could be cleared

SI_Error CSLFXOperator::ClearParameters  
 

Removes all connections points from the parameter list

Returns:
SI_Error Whether or not the list could be cleared

CSLFXOperatorConnection * CSLFXOperator::ConnectConnectionPoint CSLFXOperatorConnection   in_pToConnect
 

Adds an exisiting connection point to the connection point list

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

CSLVariantParameter * CSLFXOperator::ConnectParameter CSLVariantParameter   in_pToConnect
 

Adds an exisiting parameter to the parameter list

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

SI_Int CSLFXOperator::GetConnectionPointCount  
 

Gets the total number of connection points

Returns:
SI_Int Number of connection points

CSLFXOperatorConnection ** CSLFXOperator::GetConnectionPointList  
 

Gets a pointer to the internally-stored connection point pointer list

Returns:
CSLConnectionPoint Pointer to the list

SI_Char * CSLFXOperator::GetEffectID  
 

Gets the EffectID

Returns:
SI_Char Pointer to a string representing the EffectID

CSLFXOperator::EOutputType CSLFXOperator::GetOutputType  
 

Gets the OutputType

Returns:
SI_Int The OutputType

SI_Int CSLFXOperator::GetParameterCount  
 

Gets the total number of parameters

Returns:
SI_Int Number of parameters

CSLVariantParameter ** CSLFXOperator::GetParameterList  
 

Gets a pointer to the internally-stored parameter pointer list

Returns:
CSLParameter Pointer to the list

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

Searches for a parameter by name

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

Reimplemented from CSLTemplate.

CSLAnimatableType * CSLFXOperator::ParameterFromType EFCurveType    in_Type,
SI_Char *    in_szParameterName
[virtual]
 

Searches for a parameter by name and type

Parameters:
in_Type  Type of the parameter to look for
in_szParameterName  Name of the parameter to look for
Returns:
CSLAnimatableType Pointer to the found parameter or null if not found

Reimplemented from CSLTemplate.

SI_Error CSLFXOperator::RemoveConnectionPoint CSLFXOperatorConnection   in_pToRemove
 

Removes a connection point from the connection point list

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

SI_Error CSLFXOperator::RemoveConnectionPoint SI_Int    in_nIndex
 

Removes a connection point from the connection point list

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

SI_Error CSLFXOperator::RemoveParameter CSLVariantParameter   in_pToRemove
 

Removes a parameter from the parameter list

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

SI_Error CSLFXOperator::RemoveParameter SI_Int    in_nIndex
 

Removes a parameter from the parameter list

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

SI_Void CSLFXOperator::SetEffectID SI_Char *    in_szProgID
 

Sets the EffectID

Parameters:
in_szProgID  Pointer to a string representing the EffectID

SI_Void CSLFXOperator::SetOutputType CSLFXOperator::EOutputType    in_OutputType
 

Sets the OutputType

Parameters:
in_OutputType  New output type to use

SI_Error CSLFXOperator::Synchronize   [virtual]
 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLFXOperator::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_FXOPERATOR

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.