CSLFXOperatorConnection Class Reference



Your Ad Here

Representation of a connection in the FX Tree. More...

#include <FXNodeConnection.h>

List of all members.

Public Types
enum   EConnectionType {
  SI_NONE,
  SI_FXOPERATOR
}
  Defines the various types of connection. More...

Public Member Functions
  CSLFXOperatorConnection (CdotXSITemplate *in_pTemplate, SI_Int in_nValueIndex)
SI_Error  Synchronize ()
SI_Char *  GetName ()
SI_Void  SetName (SI_Char *in_szName)
CSLFXOperator *  GetFXOperator ()
SI_Void  SetFXOperator (CSLFXOperator *in_pNode)
EConnectionType  GetConnectionType ()
SI_Void  SetConnectionType (EConnectionType in_Type)
virtual  ~CSLFXOperatorConnection ()
  Destructor.

Detailed Description

Representation of a connection in the FX Tree.

Member Enumeration Documentation

enum EConnectionType

Defines the various types of connection.

Enumerator:
SI_NONE  not connected
SI_FXOPERATOR  connected to an effect operator

Constructor & Destructor Documentation

CSLFXOperatorConnection ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nValueIndex  
)

Constructor

Parameters:
in_pTemplate  Parent Template
in_nValueIndex  Index
Returns:
an instance of CSLFCOperatorConnection

Member Function Documentation

SI_Error Synchronize (  ) 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

SI_Char* GetName (  ) 

Gets the name of the connection

Returns:
SI_Char Name of the connection

SI_Void SetName ( SI_Char *  in_szName  ) 

Sets the name of the connection

Parameters:
in_szName  The name of the connection

CSLFXOperator* GetFXOperator (  ) 

Gets the refered node

Returns:
CSLFXOperator Pointer to the refered node or null if none

SI_Void SetFXOperator ( CSLFXOperator *  in_pNode  ) 

Sets the refered node

Parameters:
in_pNode  Pointer to the refered node or null if none

EConnectionType GetConnectionType (  ) 

Gets the connection type

Returns:
EConnectionType Type of connection

SI_Void SetConnectionType ( EConnectionType  in_Type  ) 

Sets the connection type

Parameters:
in_Type  New type of connection

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

Return to Softimage XSI Index


Your Ad Here