Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLMaterial Class Reference

#include <Material.h>

Inheritance diagram for CSLMaterial::

CSLBaseMaterial CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

CSLMaterial Class

Defines a legacy SI_Material


Member Enumeration Documentation

enum CSLMaterial::EShadingModel
 

This enum lists possible shading models for a material.

Enumeration values:
CONSTANT  Constant shading
LAMBERT  Lambert shading
PHONG  Phong shading
BLINN  Blinn shading
SHADOW_OBJECT  Shawdow object
VERTEX_COLOR  Vertex color lighting


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Pointer to the scene containing the Material
in_pModel  Pointer to the model containing the Material
in_pTemplate  Pointer to the CdotXSITemplate containing the Material

CSLMaterial::~CSLMaterial   [virtual]
 

Destructor


Member Function Documentation

CSLTexture2D * CSLMaterial::CreateTexture2D  
 

Create a new texture 2D for the material.

Returns:
CSLTexture2D Newly creates texture 2D object.

SI_Error CSLMaterial::DestroyTexture2D  
 

Destroy the texture 2D of the material.

Returns:
SI_Error Error code.

CSIBCColorf CSLMaterial::GetAmbientColor  
 

Return the ambient color of the material.

Returns:
CSIBCColorf Ambient color.

CSIBCColorf CSLMaterial::GetDiffuseColor  
 

Return the diffuse color of the material.

Returns:
CSIBCColorf Diffuse color.

CSIBCColorf CSLMaterial::GetEmissiveColor  
 

Return the emissive color of the material.

Returns:
CSIBCColorf emissive color.

CSLMaterial::EShadingModel CSLMaterial::GetShadingModel  
 

Return the shading model of the material.

Returns:
EShadingModel Shading model.

CSIBCColorf CSLMaterial::GetSpecularColor  
 

Return the specular color of the material.

Returns:
CSIBCColorf Specular color.

SI_Float CSLMaterial::GetSpecularDecay  
 

Return the specular decay of the material.

Returns:
SI_Float Specular decay.

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

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

CSLAnimatableType * CSLMaterial::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_Void CSLMaterial::SetAmbientColor CSIBCColorf   in_rColor
 

Change the ambient color of the material.

Parameters:
CSIBCColorf&  New ambient color.
Returns:
None

SI_Void CSLMaterial::SetDiffuseColor CSIBCColorf   in_rColor
 

Change the diffuset color of the material.

Parameters:
CSIBCColorf&  New diffuse color.
Returns:
None

SI_Void CSLMaterial::SetEmissiveColor CSIBCColorf   in_rColor
 

Change the emissive color of the material.

Parameters:
CSIBCColorf&  New emissive color.
Returns:
None

SI_Void CSLMaterial::SetShadingModel EShadingModel    in_Value
 

Change the shading model of the material.

Parameters:
EShadingModel  New shading model.
Returns:
None

SI_Void CSLMaterial::SetSpecularColor CSIBCColorf   in_rColor
 

Change the specular color of the material.

Parameters:
CSIBCColorf&  New specular color
Returns:
None

SI_Void CSLMaterial::SetSpecularDecay SI_Float    in_fValue
 

Change the specular decay of the material.

Parameters:
SI_Float  New Specular decay.
Returns:
None

SI_Error CSLMaterial::Synchronize   [virtual]
 

Synchronize will ensure that the animated parameter is up to date.

Returns:
SI_Error Error code

Reimplemented from CSLBaseMaterial.

CSLTexture2D * CSLMaterial::Texture2D  
 

Return the 2D texture of the material.

Returns:
CSLTexture2D* Pointer to a texture 2D object.

CSLTemplate::ETemplateType CSLMaterial::Type   [virtual]
 

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

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.