Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLLightInfo Class Reference

Provides additional information regarding a CSLLight. More...

#include <LightInfo.h>

Inheritance diagram for CSLLightInfo::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Provides additional information regarding a CSLLight.


Member Enumeration Documentation

enum CSLLightInfo::EFallofMode
 

Defines the various fallof modes.

Enumeration values:
SI_LINEAR  Linear
SI_EXPONENT  Use exponent type


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template
Returns:
an instance of CSLLightInfo

CSLLightInfo::~CSLLightInfo   [virtual]
 

Destructor


Member Function Documentation

SI_Float CSLLightInfo::GetEnd  
 

Gets the end frame

Returns:
SI_Float the end frame

SI_Bool CSLLightInfo::GetFallofActive  
 

Gets the fallof active state

Returns:
SI_Bool Whether or not fallof is active

CSLLightInfo::EFallofMode CSLLightInfo::GetFallofMode  
 

Gets the fallof mode

Returns:
EFallofMode The fallof mode

SI_Float CSLLightInfo::GetIntensity  
 

Gets the Intensity

Returns:
SI_Float The Intensity

SI_Bool CSLLightInfo::GetLightAsEnergy  
 

Gets the light as energy active state

Returns:
SI_Bool Whether or not light as energy is active
Note:
Only values beetween 0 and 1 are valid

SI_Float CSLLightInfo::GetPhotonFactor  
 

Gets the photon factor value

Returns:
SI_Float The photon factor value

SI_Bool CSLLightInfo::GetShadowActive  
 

Gets the shadow active state

Returns:
SI_Bool Whether or not shadow is active

SI_Float CSLLightInfo::GetStart  
 

Gets the start frame

Returns:
SI_Float the start frame

SI_Float CSLLightInfo::GetUmbra  
 

Gets the Umbra value

Returns:
SI_Float The umbra value

CSLAnimatableType * CSLLightInfo::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.

SI_Void CSLLightInfo::SetEnd SI_Float    in_fEnd
 

Sets the end frame

Returns:
in_fEnd the end frame

SI_Void CSLLightInfo::SetFallofActive SI_Bool    in_bActive
 

Sets the fallof active state

Parameters:
in_bActive  Whether or not fallof is active
Returns:
SI_Void

SI_Void CSLLightInfo::SetFallofMode CSLLightInfo::EFallofMode    in_Mode
 

Sets the fallof mode

Parameters:
in_Mode  The fallof mode
Returns:
SI_Void

SI_Void CSLLightInfo::SetIntensity SI_Float    in_fIntensity
 

Sets the Intensity

Parameters:
in_fIntensity  The intensity factor
Returns:
SI_Void
Note:
Only values beetween 0 and 1.00000 are valid

SI_Void CSLLightInfo::SetLightAsEnergy SI_Bool    in_bActive
 

Sets the light as energy active state

Parameters:
in_bActive  Whether or not light as energy is active
Returns:
SI_Void

SI_Void CSLLightInfo::SetPhotonFactor SI_Float    in_fPhotonFactor = 0.75F
 

Sets the photon factor value

Parameters:
in_fPhotonFactor  The photon factor value
Returns:
SI_Void
Note:
Only values beetween 0 and 100000 are valid

SI_Void CSLLightInfo::SetShadowActive SI_Bool    in_bActive
 

Sets the shadow active state

Parameters:
in_bActive  Whether or not shadow is active
Returns:
SI_Void

SI_Void CSLLightInfo::SetStart SI_Float    in_fStart
 

Sets the start frame

Returns:
in_fStart the start frame

SI_Void CSLLightInfo::SetUmbra SI_Float    in_fUmbra = 0.75F
 

Sets the Umbra value

Parameters:
in_fUmbra  The umbra value

ETemplateType CSLLightInfo::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: SI_LIGHT_INFO

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.