Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLAmbience Class Reference

#include <Ambience.h>

Inheritance diagram for CSLAmbience::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describe the abient color fo the scene. You can retrieve ambience color information with the CSLScene::Ambience() method.

See also:
CSLScene


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Pointer to the scene containing the CSLAmbience
in_pModel  Pointer to the model containing the CSLAmbience
in_pTemplate  Pointer to the CdotXSITemplate that defines the CSLAmbience


Member Function Documentation

CSIBCColorf CSLAmbience::GetColor  
 

Returns the scene's ambient color.

Returns:
CSIBCColorf Color representing this object.

CSLAnimatableType * CSLAmbience::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 * CSLAmbience::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 CSLAmbience::SetColor CSIBCColorf   in_rColor
 

Changes the scene's ambient color.

Parameters:
in_rColor  a CSIBCColorf containing the new ambient color.

CSLTemplate::ETemplateType CSLAmbience::Type   [virtual]
 

Returns the type of this template

Return values:
CSLTemplate::SI_AMBIENCE 

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.