CSLXSIShaderCompound Class Reference

This class represents an XSI_ShaderCompound template. More...

#include <XSIShaderCompound.h>

Inheritance diagram for CSLXSIShaderCompound:

List of all members.


Public Member Functions
	CSLXSIShaderCompound (CSLScene in_pScene, CSLModel in_pModel, CdotXSITemplate in_pTemplate, CSLXSIShader in_pParentShader)
virtual	~CSLXSIShaderCompound ()
	Destructor.
ETemplateType	Type ()
SI_Error	Synchronize ()
SI_Char *	GetCategory ()
SI_Void	SetCategory (SI_Char *in_pValue)
SI_Char *	GetDescription ()
SI_Void	SetDescription (SI_Char *in_pValue)
SI_Char *	GetAuthor ()
SI_Void	SetAuthor (SI_Char *in_pValue)
SI_Char *	GetDate ()
SI_Void	SetDate (SI_Char *in_pValue)
SI_Char *	GetVersionTag ()
SI_Void	SetVersionTag (SI_Char *in_pValue)
SI_Int	GetVersionMajor ()
SI_Void	SetVersionMajor (SI_Int in_nValue)
SI_Int	GetVersionMinor ()
SI_Void	SetVersionMinor (SI_Int in_nValue)
SI_Char *	GetPPGLogic ()
SI_Void	SetPPGLogic (SI_Char *in_pValue)
SI_Char *	GetPPGLogicLanguage ()
SI_Void	SetPPGLogicLanguage (SI_Char *in_pValue)
SI_Int	GetBackgroundColor ()
SI_Void	SetBackgroundColor (SI_Int in_nValue)
void	SetParentShader (CSLXSIShader *in_pParentShader)
CSLXSIShader *	ParentShader ()
CSLXSIShaderCompoundPort *	AddShaderCompoundPort ()
SI_Error	RemoveShaderCompoundPort (SI_Int in_nIndex)
SI_Error	RemoveShaderCompoundPort (CSLXSIShaderCompoundPort *in_pToRemove)
CSLXSIShaderCompoundPort *	GetShaderCompoundPort (SI_Int in_nIndex)
SI_Int	GetShaderCompoundPortCount ()
SI_Error	ClearShaderCompoundPorts ()
CSLXSIShaderCompoundPort **	GetShaderCompoundPortList ()
CSLXSIShaderCompoundPort *	ConnectShaderCompoundPort (CSLXSIShaderCompoundPort *in_pToConnect)
CSLXSIShaderCompoundPort *	FindShaderCompoundPort (SI_Char *in_szPortName)
CSLXSIShader *	AddShader ()
SI_Error	RemoveShader (SI_Int in_nIndex)
SI_Error	RemoveShader (CSLXSIShader *in_pToRemove)
SI_Error	ClearShaders ()
CSLXSIShader *	ConnectShader (CSLXSIShader *in_pToConnect)
CSLXSIShader **	GetShaderList ()
SI_Int	GetShaderCount ()
CSLXSIShader *	FindShader (SI_Char *in_szShaderName)

Detailed Description

This class represents an XSI_ShaderCompound template.

Defines a shader compound (see the XSI_ShaderCompound template reference).

Since:: dotXSI 6.0

Constructor & Destructor Documentation

CSLXSIShaderCompound	(	CSLScene *	in_pScene,
		CSLModel *	in_pModel,
		CdotXSITemplate *	in_pTemplate,
		CSLXSIShader *	in_pParentShader
	)

Constructor

Parameters:

`[in]`	in_pScene	Parent scene
`[in]`	in_pModel	Parent model
`[in]`	in_pTemplate	Refered template
`[in]`	in_pParentShader	Parent shader

Member Function Documentation

ETemplateType Type ( ) [inline, virtual]

Returns the type of this template

Return values:

CSLTemplate::XSI_SHADER_COMPOUND

The type of this template

Implements CSLTemplate.

SI_Error Synchronize ( ) [virtual]

Commits the current template information

Returns:: Whether or not the commit was successful

Reimplemented from CSLTemplate.

SI_Char* GetCategory ( )

Returns the Category value

Returns:: Category

SI_Void SetCategory ( SI_Char * in_pValue )

Sets the Category value

Parameters:

[in] in_pValue new Category value

SI_Char* GetDescription ( )

Returns the Description value

Returns:: Description

SI_Void SetDescription ( SI_Char * in_pValue )

Sets the Description value

Parameters:

[in] in_pValue new Description value

SI_Char* GetAuthor ( )

Returns the Author value

Returns:: Author

SI_Void SetAuthor ( SI_Char * in_pValue )

Sets the Author value

Parameters:

[in] in_pValue new Author value

SI_Char* GetDate ( )

Returns the Date value

Returns:: Date

SI_Void SetDate ( SI_Char * in_pValue )

Sets the Date value

Parameters:

[in] in_pValue new Date value

SI_Char* GetVersionTag ( )

Returns the VersionTag value

Returns:: VersionTag

SI_Void SetVersionTag ( SI_Char * in_pValue )

Sets the VersionTag value

Parameters:

[in] in_pValue new VersionTag value

SI_Int GetVersionMajor ( )

Returns the VersionMajor value

Returns:: VersionMajor

SI_Void SetVersionMajor ( SI_Int in_nValue )

Sets the VersionMajor value

Parameters:

[in] in_nValue new VersionMajor value

SI_Int GetVersionMinor ( )

Returns the VersionMinor value

Returns:: VersionMinor

SI_Void SetVersionMinor ( SI_Int in_nValue )

Sets the VersionMinor value

Parameters:

[in] in_nValue new VersionMinor value

SI_Char* GetPPGLogic ( )

Returns the PPGLogic value

Returns:: PPGLogic

SI_Void SetPPGLogic ( SI_Char * in_pValue )

Sets the PPGLogic value

Parameters:

[in] in_pValue new PPGLogic value

SI_Char* GetPPGLogicLanguage ( )

Returns the PPGLogicLanguage value

Returns:: PPGLogicLanguage

SI_Void SetPPGLogicLanguage ( SI_Char * in_pValue )

Sets the PPGLogicLanguage value

Parameters:

[in] in_pValue new PPGLogicLanguage value

SI_Int GetBackgroundColor ( )

Returns the BackgroundColor value

Returns:: BackgroundColor

SI_Void SetBackgroundColor ( SI_Int in_nValue )

Sets the BackgroundColor value

Parameters:

[in] in_nValue new BackgroundColor value

void SetParentShader ( CSLXSIShader * in_pParentShader )

Sets the shader parent of this template.

Parameters:

[in] in_pParentShader Pointer to the parent shader.

CSLXSIShader* ParentShader ( )

Returns the shader parent of this template.

Returns:: Pointer to the parent shader.

CSLXSIShaderCompoundPort* AddShaderCompoundPort ( )

Adds a shader compound port to the shader compound port list

Returns:: The added shader compound port

SI_Error RemoveShaderCompoundPort ( SI_Int in_nIndex )

Removes a shader compound port from the shader compound port list

Parameters:

[in] in_nIndex Index of the shader compound port to remove

SI_Error RemoveShaderCompoundPort ( CSLXSIShaderCompoundPort * in_pToRemove )

Removes a shader compound port from the shader compound port list

Parameters:

[in] in_pToRemove The shader compound port to remove

CSLXSIShaderCompoundPort* GetShaderCompoundPort ( SI_Int in_nIndex )

Returns a CSLXSIShaderCompoundPort object by index.

Parameters:

[in] in_nIndex Index of the shader compound port to get

Returns:: The CSLXSIShaderCompoundPort object.

SI_Int GetShaderCompoundPortCount ( )

Returns the number of shader compound port in the shader compound port list

Returns:: The number of shader compound port in the shader compound port list

SI_Error ClearShaderCompoundPorts ( )

Deletes all the shader compound port form the shader compound port list

CSLXSIShaderCompoundPort** GetShaderCompoundPortList ( )

Returns a pointer to the internally-stored shader compound port pointer list

Returns:: Pointer to the list

CSLXSIShaderCompoundPort* ConnectShaderCompoundPort ( CSLXSIShaderCompoundPort * in_pToConnect )

Adds an exisiting shader compound port to the shader compound port list

Parameters:

[in] in_pToConnect Pointer to the shader compound port to add

Returns:: The added shader compound port

CSLXSIShaderCompoundPort* FindShaderCompoundPort ( SI_Char * in_szPortName )

Searches for a given shader compound port

Parameters:

[in] in_szPortName Name of the shader compound port to look for

Returns:: Pointer to the shader compound port or null if it cannot be found

CSLXSIShader* AddShader ( )

Adds a shader to the shader list

Returns:: Pointer to the newly added shader

SI_Error RemoveShader ( SI_Int in_nIndex )

Removes a shader from the shader list

Parameters:

[in] in_nIndex Index of the shader to remove

Returns:: Whether or not the shader could be removed

SI_Error RemoveShader ( CSLXSIShader * in_pToRemove )

Removes a shader from the shader list

Parameters:

[in] in_pToRemove Pointer to the shader to remove

Returns:: Whether or not the shader could be removed

SI_Error ClearShaders ( )

Removes all connections points from the shader list

Returns:: Whether or not the list could be cleared

CSLXSIShader* ConnectShader ( CSLXSIShader * in_pToConnect )

Adds an exisiting shader to the shader list

Parameters:

[in] in_pToConnect Pointer to the shader to add

Returns:: The added shader or null if it already exists in the list

CSLXSIShader** GetShaderList ( )

Returns a pointer to the internally-stored shader pointer list

Returns:: Pointer to the list

SI_Int GetShaderCount ( )

Returns the total number of Shaders

Returns:: Number of Shaders

CSLXSIShader* FindShader ( SI_Char * in_szShaderName )

Searches for a given shader

Parameters:

[in] in_szShaderName Name of the shader to look for

Returns:: Pointer to the shader or null if it cannot be found

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

XSIShaderCompound.h

CSLXSIShaderCompound Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation