CSLFXOperator Class Reference

This class represents an XSI_FXOperator template. More...

#include <FXNode.h>

Inheritance diagram for CSLFXOperator:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EOutputType { SI_DEFAULT = 0 }
  Describes the various output types. More...

Public Member Functions
  CSLFXOperator (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLFXOperator ()
  Destructor.
ETemplateType  Type ()
SI_Error  Synchronize ()
EOutputType  GetOutputType ()
SI_Void  SetOutputType (EOutputType in_OutputType)
SI_Char *  GetEffectID ()
SI_Void  SetEffectID (SI_Char *in_szProgID)
CSLVariantParameter *  AddParameter ()
SI_Error  RemoveParameter (SI_Int in_nIndex)
SI_Error  RemoveParameter (CSLVariantParameter *in_pToRemove)
SI_Error  ClearParameters ()
CSLVariantParameter *  ConnectParameter (CSLVariantParameter *in_pToConnect)
CSLVariantParameter **  GetParameterList ()
SI_Int  GetParameterCount ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
CSLFXOperatorConnection *  AddConnectionPoint ()
SI_Error  RemoveConnectionPoint (SI_Int in_nIndex)
SI_Error  RemoveConnectionPoint (CSLFXOperatorConnection *in_pToRemove)
SI_Error  ClearConnectionPoints ()
CSLFXOperatorConnection *  ConnectConnectionPoint (CSLFXOperatorConnection *in_pToConnect)
CSLFXOperatorConnection **  GetConnectionPointList ()
SI_Int  GetConnectionPointCount ()

Detailed Description

This class represents an XSI_FXOperator template.

Representation of an operator in the FX Tree (see the XSI_FXOperator template reference).

Member Enumeration Documentation

enum EOutputType

Describes the various output types.

Enumerator:
SI_DEFAULT  Default output type

Constructor & Destructor Documentation

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

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

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

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Commits semantic layer data

Returns:
Whether or not commit was a success

Reimplemented from CSLTemplate.

EOutputType GetOutputType (  ) 

Returns the OutputType

Returns:
The OutputType

SI_Void SetOutputType ( EOutputType  in_OutputType  ) 

Sets the OutputType

Parameters:
[in]  in_OutputType  New output type to use

SI_Char* GetEffectID (  ) 

Returns the EffectID

Returns:
Pointer to a string representing the EffectID

SI_Void SetEffectID ( SI_Char *  in_szProgID  ) 

Sets the EffectID

Parameters:
[in]  in_szProgID  Pointer to a string representing the EffectID

CSLVariantParameter* AddParameter (  ) 

Adds a parameter to the parameter list

Returns:
Pointer to the newly added parameter

SI_Error RemoveParameter ( SI_Int  in_nIndex  ) 

Removes a parameter from the parameter list

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

SI_Error RemoveParameter ( CSLVariantParameter *  in_pToRemove  ) 

Removes a parameter from the parameter list

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

SI_Error ClearParameters (  ) 

Removes all connections points from the parameter list

Returns:
Whether or not the list could be cleared

CSLVariantParameter* ConnectParameter ( CSLVariantParameter *  in_pToConnect  ) 

Adds an exisiting parameter to the parameter list

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

CSLVariantParameter** GetParameterList (  ) 

Returns a pointer to the internally-stored parameter pointer list

Returns:
Pointer to the list

SI_Int GetParameterCount (  ) 

Returns the total number of parameters

Returns:
Number of parameters

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

Searches for a parameter by name

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

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szParameterName  
) [virtual]

Searches for a parameter by name and type

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

Reimplemented from CSLTemplate.

CSLFXOperatorConnection* AddConnectionPoint (  ) 

Adds a connection point to the connection point list

Returns:
Pointer to the newly added connection point

SI_Error RemoveConnectionPoint ( SI_Int  in_nIndex  ) 

Removes a connection point from the connection point list

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

SI_Error RemoveConnectionPoint ( CSLFXOperatorConnection *  in_pToRemove  ) 

Removes a connection point from the connection point list

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

SI_Error ClearConnectionPoints (  ) 

Removes all connections points from the connection point list

Returns:
Whether or not the list could be cleared

CSLFXOperatorConnection* ConnectConnectionPoint ( CSLFXOperatorConnection *  in_pToConnect  ) 

Adds an exisiting connection point to the connection point list

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

CSLFXOperatorConnection** GetConnectionPointList (  ) 

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

Returns:
Pointer to the list

SI_Int GetConnectionPointCount (  ) 

Returns the total number of connection points

Returns:
Number of connection points

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