CSLXSIShaderCompoundPort Class Reference

This class represents an XSI_ShaderCompoundPort template. More...

#include <XSIShaderCompoundPort.h>

Inheritance diagram for CSLXSIShaderCompoundPort:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EPortType {
  SI_INPUT_PORT,
  SI_OUTPUT_PORT
}
  Defines the various port types. More...

Public Member Functions
  CSLXSIShaderCompoundPort (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSIShaderCompoundPort ()
  Destructor.
SI_Error  Synchronize ()
ETemplateType  Type ()
EPortType  GetPortType ()
SI_Void  SetPortType (EPortType in_eValue)
SI_Char *  GetDisplayName ()
SI_Void  SetDisplayName (SI_Char *in_pValue)
SI_Char *  GetPPGMinValue ()
SI_Void  SetPPGMinValue (SI_Char *in_pValue)
SI_Char *  GetPPGMaxValue ()
SI_Void  SetPPGMaxValue (SI_Char *in_pValue)
SI_Char *  GetPPGEnumValues ()
SI_Void  SetPPGEnumValues (SI_Char *in_pValue)
SI_Bool  GetPPGLayoutVisible ()
SI_Void  SetPPGLayoutVisible (SI_Bool in_nValue)
SI_Char *  GetPPGLayoutGroup ()
SI_Void  SetPPGLayoutGroup (SI_Char *in_pValue)
SI_Char *  GetPPGLayoutTab ()
SI_Void  SetPPGLayoutTab (SI_Char *in_pValue)
SI_Bool  GetRTLayoutVisible ()
SI_Void  SetRTLayoutVisible (SI_Bool in_pValue)
SI_Char *  GetRTLayoutGroup ()
SI_Void  SetRTLayoutGroup (SI_Char *in_pValue)
CSLXSIShader *  GetSourceShader ()
SI_Void  SetSourceShader (CSLXSIShader *in_pSourceShader)

Detailed Description

This class represents an XSI_ShaderCompoundPort template.

Defines a shader compound port (see the XSI_ShaderCompoundPort template reference).

Since:
dotXSI 6.0

Member Enumeration Documentation

enum EPortType

Defines the various port types.

Enumerator:
SI_INPUT_PORT  0-Input Port
SI_OUTPUT_PORT  1-Output Port

Constructor & Destructor Documentation

CSLXSIShaderCompoundPort ( 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

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

Commits the current template information

Returns:
Whether or not the commit was successful

Reimplemented from CSLTemplate.

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

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

Implements CSLTemplate.

EPortType GetPortType (  ) 

Returns the PortType value

Returns:
Port Type

SI_Void SetPortType ( EPortType  in_eValue  ) 

Sets the PortType value

Parameters:
[in]  in_eValue  new PortType value

SI_Char* GetDisplayName (  ) 

Returns the DisplayName value

Returns:
DisplayName

SI_Void SetDisplayName ( SI_Char *  in_pValue  ) 

Sets the DisplayName value

Parameters:
[in]  in_pValue  new DisplayName value

SI_Char* GetPPGMinValue (  ) 

Returns the PPGMinValue value

Returns:
PPGMinValue

SI_Void SetPPGMinValue ( SI_Char *  in_pValue  ) 

Sets the PPGMinValue value

Parameters:
[in]  in_pValue  new PPGMinValue value

SI_Char* GetPPGMaxValue (  ) 

Returns the PPGMaxValue value

Returns:
PPGMaxValue

SI_Void SetPPGMaxValue ( SI_Char *  in_pValue  ) 

Sets the PPGMaxValue value

Parameters:
[in]  in_pValue  new PPGMaxValue value

SI_Char* GetPPGEnumValues (  ) 

Returns the PPGEnumValues value

Returns:
PPGEnumValues

SI_Void SetPPGEnumValues ( SI_Char *  in_pValue  ) 

Sets the PPGEnumValues value

Parameters:
[in]  in_pValue  new PPGEnumValues value

SI_Bool GetPPGLayoutVisible (  ) 

Returns the PPGLayoutVisible value

Returns:
PPGLayoutVisible

SI_Void SetPPGLayoutVisible ( SI_Bool  in_nValue  ) 

Sets the PPGLayoutVisible value

Parameters:
[in]  in_nValue  new PPGLayoutVisible value

SI_Char* GetPPGLayoutGroup (  ) 

Returns the PPGLayoutGroup value

Returns:
PPGLayoutGroup

SI_Void SetPPGLayoutGroup ( SI_Char *  in_pValue  ) 

Sets the PPGLayoutGroup value

Parameters:
[in]  in_pValue  new PPGLayoutGroup value

SI_Char* GetPPGLayoutTab (  ) 

Returns the PPGLayoutTab value

Returns:
PPGLayoutTab

SI_Void SetPPGLayoutTab ( SI_Char *  in_pValue  ) 

Sets the PPGLayoutTab value

Parameters:
[in]  in_pValue  new PPGLayoutTab value

SI_Bool GetRTLayoutVisible (  ) 

Returns the RTLayoutVisible value

Returns:
RTLayoutVisible

SI_Void SetRTLayoutVisible ( SI_Bool  in_pValue  ) 

Sets the RTLayoutVisible value

Parameters:
[in]  in_pValue  new RTLayoutVisible value

SI_Char* GetRTLayoutGroup (  ) 

Returns the RTLayoutGroup value

Returns:
RTLayoutGroup

SI_Void SetRTLayoutGroup ( SI_Char *  in_pValue  ) 

Sets the RTLayoutGroup value

Parameters:
[in]  in_pValue  new RTLayoutGroup value

CSLXSIShader* GetSourceShader (  ) 

Returns the Source Shader

Returns:
the Source Shader

SI_Void SetSourceShader ( CSLXSIShader *  in_pSourceShader  ) 

Sets the Source Shader

Parameters:
[in]  in_pSourceShader  new Source Shader

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