Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLMaterialLibrary Class Reference

#include <MaterialLibrary.h>

Inheritance diagram for CSLMaterialLibrary::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

CSLMaterialLibrary class Handles the material library. From this class you can add or remove materials that can be used in the scene.


Member Function Documentation

CSLMaterial * CSLMaterialLibrary::AddMaterial  
 

Add a new material to the material library.

Returns:
CSLMaterial* Pointer to the newly created material object.

CSLXSIMaterial * CSLMaterialLibrary::AddXSIMaterial  
 

Add a new XSI material to the material library.

Returns:
CSLMaterial* Pointer to the newly created XSI material object.

SI_Error CSLMaterialLibrary::ClearMaterials  
 

Remove all materials from the material library.

Returns:
SI_Error Error code.

SI_Int CSLMaterialLibrary::GetMaterialCount  
 

Return the number of materials in the library.

Returns:
SI_Int Number of materials.

CSLBaseMaterial ** CSLMaterialLibrary::GetMaterialList  
 

Return an array of all materials in the library.

Returns:
CSLBaseMaterial** Array of pointers to material objects.

SI_Error CSLMaterialLibrary::RemoveMaterial CSLBaseMaterial   in_pMaterial
 

Remove a single material from the library.

Parameters:
CSLBaseMaterial  * Pointer to the material to remove.
Returns:
SI_Error Error code.

SI_Error CSLMaterialLibrary::RemoveMaterial SI_Int    in_nIndex
 

Remove a single material from the library.

Parameters:
SI_Int  Index of the material to remove.
Returns:
SI_Error Error code.

SI_Error CSLMaterialLibrary::Synchronize   [virtual]
 

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

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLMaterialLibrary::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.