CSLConnectionPoint Class Reference

Represents connection points. More...

#include <ConnectionPoint.h>

Inheritance diagram for CSLConnectionPoint:

CSLShaderConnectionPoint List of all members.

Public Member Functions
  CSLConnectionPoint (CdotXSITemplate *in_pTemplate, SI_Int in_nValueIndex)
virtual  ~CSLConnectionPoint ()
SI_Void  SetName (SI_Char *in_szName)
SI_Char *  GetName ()
SI_TinyVariant *  GetValue ()
SI_Void  SetShader (CSLXSIShader *in_pShader)
CSLXSIShader *  GetShader ()
virtual SI_Error  Synchronize ()
CdotXSIParam *  GetParam ()

Friends
class  CSLScene

Detailed Description

Represents connection points.

Constructor & Destructor Documentation

CSLConnectionPoint ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nValueIndex  
)

Constructor

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

virtual ~CSLConnectionPoint (  )  [virtual]

Destructor

Member Function Documentation

SI_Void SetName ( SI_Char *  in_szName  ) 

Set the name of the connection point

Parameters:
in_szName  Name of the connection point
Returns:
SI_Void

SI_Char* GetName (  ) 

Gets the name of the connection point

Returns:
SI_Char Name of the connection point

SI_TinyVariant* GetValue (  ) 

Gets the value of the connection point

Returns:
SI_TinyVariant Value of the connection point

SI_Void SetShader ( CSLXSIShader *  in_pShader  ) 

Set the shader of the connection point

Parameters:
in_pShader  Pointer to the shader to connect
Returns:
SI_Void

CSLXSIShader* GetShader (  ) 

Get the shader of the connection point

Returns:
Pointer to the shader

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this connection point instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented in CSLShaderConnectionPoint.

CdotXSIParam* GetParam (  )  [inline]

Gets the parameter that holds the name of the connection point

Returns:
CdotXSIParam* Pointer to the param that holds the name of the connection point

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