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

Provides additional information regarding a CSLLight.

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_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template
Returns:
an instance of CSLLightInfo

virtual ~CSLLightInfo (  )  [virtual]

Destructor

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Gets the type of this template

Returns:
ETemplateType The type of this template: SI_LIGHT_INFO

Implements CSLTemplate.

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

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szName  
) [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_Bool GetFallofActive (  ) 

Gets the fallof active state

Returns:
SI_Bool Whether or not fallof is active

SI_Void SetFallofActive ( SI_Bool  in_bActive  ) 

Sets the fallof active state

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

EFallofMode GetFallofMode (  ) 

Gets the fallof mode

Returns:
EFallofMode The fallof mode

SI_Void SetFallofMode ( EFallofMode  in_Mode  ) 

Sets the fallof mode

Parameters:
in_Mode  The fallof mode
Returns:
SI_Void

SI_Float GetStart (  ) 

Gets the start frame

Returns:
SI_Float the start frame

SI_Void SetStart ( SI_Float  in_fStart  ) 

Sets the start frame

Returns:
in_fStart the start frame

SI_Float GetEnd (  ) 

Gets the end frame

Returns:
SI_Float the end frame

SI_Void SetEnd ( SI_Float  in_fEnd  ) 

Sets the end frame

Returns:
in_fEnd the end frame

SI_Bool GetShadowActive (  ) 

Gets the shadow active state

Returns:
SI_Bool Whether or not shadow is active

SI_Void SetShadowActive ( SI_Bool  in_bActive  ) 

Sets the shadow active state

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

SI_Float GetUmbra (  ) 

Gets the Umbra value

Returns:
SI_Float The umbra value

SI_Void SetUmbra ( SI_Float  in_fUmbra = 0.75F  ) 

Sets the Umbra value

Parameters:
in_fUmbra  The umbra value

SI_Bool 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_Void 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_Float GetPhotonFactor (  ) 

Gets the photon factor value

Returns:
SI_Float The photon factor value

SI_Void 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_Float GetIntensity (  ) 

Gets the Intensity

Returns:
SI_Float The Intensity

SI_Void 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

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