CSLLightInfo Class Reference

This class represents an SI_LightInfo template. More...

#include <LightInfo.h>

Inheritance diagram for CSLLightInfo:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EFallofMode {
  SI_LINEAR,
  SI_EXPONENT
}
  Defines the various fallof modes. More...

Public Member Functions
  CSLLightInfo (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLLightInfo ()
ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szName)
SI_Bool  GetFallofActive ()
SI_Void  SetFallofActive (SI_Bool in_bActive)
EFallofMode  GetFallofMode ()
SI_Void  SetFallofMode (EFallofMode in_Mode)
SI_Float  GetStart ()
SI_Void  SetStart (SI_Float in_fStart)
SI_Float  GetEnd ()
SI_Void  SetEnd (SI_Float in_fEnd)
SI_Bool  GetShadowActive ()
SI_Void  SetShadowActive (SI_Bool in_bActive)
SI_Float  GetUmbra ()
SI_Void  SetUmbra (SI_Float in_fUmbra=0.75F)
SI_Bool  GetLightAsEnergy ()
SI_Void  SetLightAsEnergy (SI_Bool in_bActive)
SI_Float  GetPhotonFactor ()
SI_Void  SetPhotonFactor (SI_Float in_fPhotonFactor=0.75F)
SI_Float  GetIntensity ()
SI_Void  SetIntensity (SI_Float in_fIntensity)

Detailed Description

This class represents an SI_LightInfo template.

Provides additional information regarding a CSLLight (see the SI_LightInfo template reference).

Member Enumeration Documentation

enum EFallofMode

Defines the various fallof modes.

Enumerator:
SI_LINEAR  Linear
SI_EXPONENT  Use exponent type

Constructor & Destructor Documentation

CSLLightInfo ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

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

virtual ~CSLLightInfo (  )  [virtual]

Destructor

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_LIGHT_INFO  The type of this template

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns the parameter specified by name

Parameters:
[in]  in_szName  Name of the parameter to retrieve
Returns:
Pointer to the parameter

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szName  
) [virtual]

Returns the parameter specified by type

Parameters:
[in]  in_Type  Type of the parameter to retrieve
[in]  in_szName  Name of the parameter to retrieve (fallback in case we can't find it by type)
Returns:
Pointer to the parameter

Reimplemented from CSLTemplate.

SI_Bool GetFallofActive (  ) 

Returns the fallof active state

Returns:
Whether or not fallof is active

SI_Void SetFallofActive ( SI_Bool  in_bActive  ) 

Sets the fallof active state

Parameters:
[in]  in_bActive  Whether or not fallof is active

EFallofMode GetFallofMode (  ) 

Returns the fallof mode

Returns:
The fallof mode

SI_Void SetFallofMode ( EFallofMode  in_Mode  ) 

Sets the fallof mode

Parameters:
[in]  in_Mode  The fallof mode

SI_Float GetStart (  ) 

Returns the start frame

Returns:
the start frame

SI_Void SetStart ( SI_Float  in_fStart  ) 

Sets the start frame

Parameters:
[in]  in_fStart  the start frame

SI_Float GetEnd (  ) 

Returns the end frame

Returns:
the end frame

SI_Void SetEnd ( SI_Float  in_fEnd  ) 

Sets the end frame

Parameters:
[in]  in_fEnd  the end frame

SI_Bool GetShadowActive (  ) 

Returns the shadow active state

Returns:
Whether or not shadow is active

SI_Void SetShadowActive ( SI_Bool  in_bActive  ) 

Sets the shadow active state

Parameters:
[in]  in_bActive  Whether or not shadow is active

SI_Float GetUmbra (  ) 

Returns the Umbra value

Returns:
The umbra value

SI_Void SetUmbra ( SI_Float  in_fUmbra = 0.75F  ) 

Sets the Umbra value

Parameters:
[in]  in_fUmbra  The umbra value

SI_Bool GetLightAsEnergy (  ) 

Returns the light as energy active state

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

SI_Void SetLightAsEnergy ( SI_Bool  in_bActive  ) 

Sets the light as energy active state

Parameters:
[in]  in_bActive  Whether or not light as energy is active

SI_Float GetPhotonFactor (  ) 

Returns the photon factor value

Returns:
The photon factor value

SI_Void SetPhotonFactor ( SI_Float  in_fPhotonFactor = 0.75F  ) 

Sets the photon factor value

Note:
Only values beetween 0 and 100000 are valid
Parameters:
[in]  in_fPhotonFactor  The photon factor value

SI_Float GetIntensity (  ) 

Returns the Intensity

Returns:
The Intensity

SI_Void SetIntensity ( SI_Float  in_fIntensity  ) 

Sets the Intensity

Note:
Only values beetween 0 and 1.00000 are valid
Parameters:
[in]  in_fIntensity  The intensity factor

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