Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLXSIShader Class Reference

#include <XSIShader.h>

Inheritance diagram for CSLXSIShader::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Class CSLXSIShader

Describes a single XSI Shader node

Note:
This template was introduced in dotXSI Version 3.6
See also:
CSLVariantParameter , CSLShaderConnectionPoint , CSLShaderInstanceData


Member Enumeration Documentation

enum CSLXSIShader::EOutputType
 

Output types.

Enumeration values:
SI_OT_UNKNOWN  Unknown output type
SI_OT_BOOLEAN  Boolean shader output type
SI_OT_INTEGER  Integer shader output type
SI_OT_SCALAR  Scalar shader output type
SI_OT_COLOR  Color shader output type
SI_OT_VECTOR  Vector shader output type
SI_OT_TEXTURE_SPACE  Texture space shader output type
SI_OT_TEXTURE  Texture shader output type
SI_OT_STRING  String shader output type
SI_OT_FILENAME  Filename shader output type
SI_OT_LENS  Lens shader output type
SI_OT_LIGHT  Light shader output type
SI_OT_MATERIAL  Material shader output type
SI_OT_MODEL  Model shader output type


Constructor & Destructor Documentation

CSLXSIShader::CSLXSIShader CSLScene   in_pScene,
CSLModel   in_pParentModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template


Member Function Documentation

CSLShaderConnectionPoint * CSLXSIShader::AddConnectionPoint  
 

Add a connection point to the connection point list

Returns:
CSLShaderConnectionPoint Pointer to the newly added connection point

CSLShaderInstanceData * CSLXSIShader::AddInstanceData  
 

Adds an instance data to the instance data list

Returns:
CSLShaderInstanceData Pointer to the newly added instance data

CSLVariantParameter * CSLXSIShader::AddParameter  
 

Add a parameter to the parameter list

Returns:
CSLParameter Pointer to the newly added parameter

SI_Error CSLXSIShader::ClearConnectionPoints  
 

Removes all connections points from the connection point list

Returns:
SI_Error Whether or not the list could be cleared

SI_Error CSLXSIShader::ClearInstanceDatas  
 

Removes all instance datas from the shader

Returns:
SI_Error Whether or not the list could be cleared

SI_Error CSLXSIShader::ClearParameters  
 

Removes all parameters from the parameter list

Returns:
SI_Error Whether or not the list could be cleared

CSLShaderConnectionPoint * CSLXSIShader::ConnectConnectionPoint CSLShaderConnectionPoint   in_pToConnect
 

Adds an exisiting connection point to the connection point list

Parameters:
in_pToConnect  Pointer to the connection point to add
Returns:
The added connection point or null if it already exists in the list

CSLShaderInstanceData * CSLXSIShader::ConnectInstanceData CSLShaderInstanceData   in_pNewInstanceData
 

Adds an exisiting instance data to the instance data list

Parameters:
in_pToConnect  Pointer to the instance data to add
Returns:
The added instance data or null if it already exists in the list

CSLVariantParameter * CSLXSIShader::ConnectParameter CSLVariantParameter   in_pToConnect
 

Adds an exisiting parameter to the parameter list

Parameters:
in_pToConnect  Pointer to the parameter to add
Returns:
The added parameter or null if it already exists in the list

SI_Int CSLXSIShader::GetConnectionPointCount  
 

Gets the total number of connection points

Returns:
SI_Int Number of connection points

CSLShaderConnectionPoint ** CSLXSIShader::GetConnectionPointList  
 

Gets a pointer to the internally-stored connection point pointer list

Returns:
CSLConnectionPoint Pointer to the list

SI_Int CSLXSIShader::GetInstanceDataCount  
 

Gets the total number of instance datas

Returns:
SI_Int Number of instance datas

CSLShaderInstanceData ** CSLXSIShader::GetInstanceDataList  
 

Gets a pointer to the internally-stored instance data pointer list

Returns:
CSLInstanceData Pointer to the list

CSLXSIShader::EOutputType CSLXSIShader::GetOutputType  
 

Gets the OutputType

Returns:
SI_Int The OutputType

SI_Int CSLXSIShader::GetParameterCount  
 

Gets the total number of parameters

Returns:
SI_Int Number of parameters

CSLAnimatableType * CSLXSIShader::GetParameterFromModel SI_Char *    in_szParamName,
CSLModel   in_pFromModel
 

Retrieves a parameter from a model referenced by an instance data.

Parameters:
in_szParamName  Name of the parameter to fetch.
in_pFromModel  Pointer to the model to get the parameter from
Returns:
CSLAnimatableType* Pointer to the found parameter or NULL if the model or the parameter does not exist.

CSLVariantParameter ** CSLXSIShader::GetParameterList  
 

Gets a pointer to the internally-stored parameter pointer list

Returns:
CSLParameter Pointer to the list

SI_Char * CSLXSIShader::GetProgID  
 

Gets the ProgID

Returns:
SI_Char Pointer to a string representing the ProgID

CSLAnimatableType * CSLXSIShader::ParameterFromName SI_Char *    in_szName [virtual]
 

Searches for a parameter by name

Parameters:
in_szName  Name of the parameter to look for
Returns:
CSLAnimatableType Pointer to the found parameter or null if not found

Reimplemented from CSLTemplate.

CSLAnimatableType * CSLXSIShader::ParameterFromType EFCurveType    in_Type,
SI_Char *    in_szParameterName
[virtual]
 

Return a proxy to the specified parameter.

Parameters:
in_Type  Type of parameter
in_szParameterName  Name of the parameter if the type is SI_PARAMETER
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Error CSLXSIShader::RemoveConnectionPoint CSLShaderConnectionPoint   in_pToRemove
 

Removes a connection point from the connection point list

Parameters:
in_pToRemove  Pointer to the connection point to remove
Returns:
SI_Error Whether or not the connection point could be removed

SI_Error CSLXSIShader::RemoveConnectionPoint SI_Int    in_nIndex
 

Removes a connection point from the connection point list

Parameters:
in_nIndex  Index of the connection point to remove
Returns:
SI_Error Whether or not the connection point could be removed

SI_Error CSLXSIShader::RemoveInstanceData CSLShaderInstanceData   io_pToRemove
 

Removes an instance data from the instance data list

Parameters:
in_pToRemove  Pointer to the instance data to remove
Returns:
SI_Error Whether or not the instance data could be removed

SI_Error CSLXSIShader::RemoveInstanceData SI_Int    in_nIndex
 

Removes an instance data from the instance data list

Parameters:
in_nIndex  Index of the instance data to remove
Returns:
SI_Error Whether or not the instance data could be removed

SI_Error CSLXSIShader::RemoveParameter CSLVariantParameter   in_pToRemove
 

Removes a parameter from the parameter list

Parameters:
in_pToRemove  Pointer to the parameter to remove
Returns:
SI_Error Whether or not the parameter could be removed

SI_Error CSLXSIShader::RemoveParameter SI_Int    in_nIndex
 

Removes a parameter from the parameter list

Parameters:
in_nIndex  Index of the parameter to remove
Returns:
SI_Error Whether or not the parameter could be removed

SI_Void CSLXSIShader::SetOutputType CSLXSIShader::EOutputType    in_OutputType
 

Sets the OutputType

Parameters:
in_OutputType  New output type to use

SI_Void CSLXSIShader::SetProgID SI_Char *    in_szProgID
 

Sets the ProgID

Parameters:
in_szProgID  Pointer to a string representing the ProgID

SI_Error CSLXSIShader::Synchronize   [virtual]
 

Commit the current template information

Returns:
SI_Error Whether or not the commit was successful

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLXSIShader::Type   [inline, virtual]
 

Returns the type of this template (XSI_SHADER)

Returns:
CSLTemplate::ETemplateType The type of this template (XSI_SHADER)

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.