CSLAmbience Class Reference

#include <Ambience.h>

Inheritance diagram for CSLAmbience:

List of all members.


Public Member Functions
	CSLAmbience (CSLScene in_pScene, CSLModel in_pModel, CdotXSITemplate *in_pTemplate)
CSIBCColorf	GetColor ()
SI_Void	SetColor (CSIBCColorf &in_rColor)
virtual ETemplateType	Type ()
CSLAnimatableType *	ParameterFromName (SI_Char *in_szName)
CSLAnimatableType *	ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)

Detailed Description

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

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

CSIBCColorf GetColor ( )

Returns the scene's ambient color.

SI_Void SetColor ( CSIBCColorf & in_rColor )

Changes the scene's ambient color.

Parameters:

in_rColor

a CSIBCColorf containing the new ambient color.

virtual ETemplateType Type ( ) [virtual]

Returns the type of this template

Return values:

CSLTemplate::SI_AMBIENCE

Implements CSLTemplate.

CSLAnimatableType* ParameterFromName ( SI_Char * in_szName ) [virtual]

Return a proxy to the specified parameter.

Parameters:

in_szName

Name of the parameter

Reimplemented from CSLTemplate.

CSLAnimatableType* 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

Reimplemented from CSLTemplate.

The documentation for this class was generated from the following file: