Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLXSIMaterial Class Reference

#include <XSIMaterial.h>

Inheritance diagram for CSLXSIMaterial::

CSLBaseMaterial CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Class CSLXSIMaterial

Describes an XSIMaterial

The role of the XSIMaterial class is to help build a shader tree that describes an effect. They are containers of CSLXSIShader objects and CSLConnectionPoint objects.

To get more information on XSI Material, see also the SOFTIMAGE|XSI Documentation on the render tree and the SOFTIMAGE|XSI SDK Documentation on Realtime Shaders.

Note:
This template was introduced in dotXSI Version 3.6


Constructor & Destructor Documentation

CSLXSIMaterial::CSLXSIMaterial CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template


Member Function Documentation

CSLConnectionPoint * CSLXSIMaterial::AddConnectionPoint  
 

Add a connection point to the connection point list

Returns:
CSLConnectionPoint Pointer to the newly added connection point

CSLXSIShader * CSLXSIMaterial::AddShader  
 

Adds a shader to the shader list

Returns:
CSLXSIShaderPointer to the newly added shader

SI_Error CSLXSIMaterial::ClearConnectionPoints  
 

Removes all connections points from the connection point list

Returns:
SI_Error Whether or not the list could be cleared

SI_Error CSLXSIMaterial::ClearShaders  
 

Removes all connections points from the shader list

Returns:
SI_Error Whether or not the list could be cleared

CSLConnectionPoint * CSLXSIMaterial::ConnectConnectionPoint CSLConnectionPoint   in_pNewConnectionPoint
 

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

CSLXSIMaterialInfo * CSLXSIMaterial::ConnectMaterialInfo CSLXSIMaterialInfo   in_pNewMaterialInfo
 

Connects an exisiting material info

Parameters:
in_pToConnect  Pointer to the material info to use
Returns:
The added material info or null if there's already one

CSLXSIShader * CSLXSIMaterial::ConnectShader CSLXSIShader   in_pNewShader
 

Adds an exisiting shader to the shader list

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

CSLXSIMaterialInfo * CSLXSIMaterial::CreateMaterialInfo  
 

Creates a new material info

Returns:
The new material info or null if there's already one

SI_Error CSLXSIMaterial::DestroyMaterialInfo  
 

Destroys the material info

Returns:
SI_Error Whether or not the material info could be destroyed

CSLXSIShader * CSLXSIMaterial::FindShader SI_Char *    in_szShaderName
 

Searches for a given shader

Parameters:
in_szShaderName  Name of the shader to look for
Returns:
CSLXSIShader Pointer to the shader or null if it cannot be found

SI_Int CSLXSIMaterial::GetConnectionPointCount  
 

Gets the total number of connection points

Returns:
SI_Int Number of connection points

CSLConnectionPoint ** CSLXSIMaterial::GetConnectionPointList  
 

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

Returns:
CSLConnectionPoint Pointer to the list

CSLXSIMaterialInfo * CSLXSIMaterial::GetMaterialInfo  
 

Gets a pointer to the material info

Returns:
CSLXSIMaterialInfo Pointer to the material info

SI_Int CSLXSIMaterial::GetShaderCount  
 

Gets the total number of Shaders

Returns:
SI_Int Number of Shaders

CSLXSIShader ** CSLXSIMaterial::GetShaderList  
 

Gets a pointer to the internally-stored shader pointer list

Returns:
CSLXSIShader Pointer to the list

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

Searches for a parameter

Parameters:
in_szName  Name of the parameter to look for
Returns:
CSLAnimatableType Pointer to the found parameter, null otherwise

Reimplemented from CSLTemplate.

SI_Error CSLXSIMaterial::RemoveConnectionPoint CSLConnectionPoint   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 CSLXSIMaterial::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 CSLXSIMaterial::RemoveShader CSLXSIShader   in_pToRemove
 

Removes a shader from the shader list

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

SI_Error CSLXSIMaterial::RemoveShader SI_Int    in_nIndex
 

Removes a shader from the shader list

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

SI_Error CSLXSIMaterial::Synchronize   [virtual]
 

Commit the current template information

Returns:
SI_Error Whether or not the commit was successful

Reimplemented from CSLBaseMaterial.

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

Returns the type of this template (XSI_MATERIAL)

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

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.