CSLXSIShaderMultiPortConnection Class Reference

This class represents an XSI_ShaderMultiPortConnection template. More...

#include <XSIShaderMultiPortConnection.h>

Inheritance diagram for CSLXSIShaderMultiPortConnection:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLXSIShaderMultiPortConnection (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSIShaderMultiPortConnection ()
SI_Error  Synchronize ()
CSLTemplate::ETemplateType  Type ()
SI_Char *  GetParameter ()
SI_Void  SetParameter (SI_Char *in_pParameter)
CSLStringProxy *  GetParameterProxy ()
SI_Char *  GetPortName ()
SI_Void  SetPortName (SI_Char *in_pPortName)
CSLStringProxy *  GetPortNameProxy ()

Detailed Description

This class represents an XSI_ShaderMultiPortConnection template.

Describes to which port a given shader parameter is connected on a multiple output port shader (see the XSI_ShaderMultiPortConnection template reference).

See also:
CSLXSIShader

CSLXSIShaderMultiPort

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the CSLXSIShaderMultiPortConnection
[in]  in_pModel  Pointer to the model containing the CSLXSIShaderMultiPortConnection
[in]  in_pTemplate  Pointer to the CdotXSITemplate defining the CSLXSIShaderMultiPortConnection

virtual ~CSLXSIShaderMultiPortConnection (  )  [virtual]

Destructor

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

Synchronizes to ensure that the animated parameter is up to date.

Returns:
Error code

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_SHADER_MULTI_PORT_CONNECTION  Template type

Implements CSLTemplate.

SI_Char* GetParameter (  ) 

Returns the name of the parameter to which this CSLXSIShaderMultiPortConnection applies to

Return values:
SI_Char  The name of the parameter

SI_Void SetParameter ( SI_Char *  in_pParameter  ) 

Sets the name of the parameter to which this CSLXSIShaderMultiPortConnection applies to

Parameters:
[in]  in_pParameter  The name of the parameter

CSLStringProxy* GetParameterProxy (  )  [inline]

Returns the parameter name proxy

Returns:
Pointer to parameter name proxy

SI_Char* GetPortName (  ) 

Returns the name of the port connected to the parameter

Returns:
The name of the port

SI_Void SetPortName ( SI_Char *  in_pPortName  ) 

Sets the name of the port connected to the parameter

Parameters:
[in]  in_pPortName  The name of the port connected to the parameter

CSLStringProxy* GetPortNameProxy (  )  [inline]

Returns the port name proxy

Returns:
Pointer to port name proxy

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