# CSLXSIShaderMultiPortConnection Class Reference

`#include <XSIShaderMultiPortConnection.h>`

Inheritance diagram for CSLXSIShaderMultiPortConnection:

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

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_pScene | Pointer to the scene containing the CSLXSIShaderMultiPortConnection
  | in_pModel | Pointer to the model containing the CSLXSIShaderMultiPortConnection
  | in_pTemplate | Pointer to the CdotXSITemplate defining the CSLXSIShaderMultiPortConnection

virtual ~CSLXSIShaderMultiPortConnection | ( |  | ) | `[virtual]`

Destructor

## Member Function Documentation

SI_Error Synchronize | ( |  | ) | `[virtual]`

Synchronize will ensure that the animated parameter is up to date.

Returns:
  SI_Error Error code

Reimplemented from CSLTemplate.

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

Gets the type of this template

Returns:
  CSLTemplate::XSI_SHADER_MULTI_PORT_CONNECTION

Implements CSLTemplate.

SI_Char* GetParameter | ( |  | ) |

Gets 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_pParameter | The name of the parameter

CSLStringProxy* GetParameterProxy | ( |  | ) | `[inline]`

Gets the parameter name proxy

Returns:
  CSLStringProxy* Pointer to parameter name proxy

SI_Char* GetPortName | ( |  | ) |

Gets the name of the port connected to the parameter

Returns:
  SI_Char The name of the port

SI_Void SetPortName | ( | SI_Char * | in_pPortName | ) |

Sets the name of the port connected to the parameter

Parameters:

  | in_szPortName | The name of the port connected to the parameter

CSLStringProxy* GetPortNameProxy | ( |  | ) | `[inline]`

Gets the port name proxy

Returns:
  CSLStringProxy* Pointer to port name proxy

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

- XSIShaderMultiPortConnection.h