CSLSpotLight Class Reference

Describes a spot light and its interest. More...

#include <SpotLight.h>

Inheritance diagram for CSLSpotLight:

CSLLight CSLPrimitive CSLConstrainableType CSLTemplate CSIBCNode CSLCOLLADASpotLight List of all members.

Public Member Functions
  CSLSpotLight (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLSpotLight ()
CSIBCVector3D  GetInterestPosition ()
SI_Void  SetInterestPosition (CSIBCVector3D &in_rValue)
SI_Float  GetConeAngle ()
SI_Void  SetConeAngle (SI_Float in_fValue)
SI_Float  GetSpreadAngle ()
SI_Void  SetSpreadAngle (SI_Float in_fValue)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)

Detailed Description

Describes a spot light and its interest.

Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  scene to add this spotlight to
in_pModel  model to add this light to
in_pTemplate  IO layer template to connect to
Returns:
an instance of CSLSpotLight

virtual ~CSLSpotLight (  )  [virtual]

Destructor

Member Function Documentation

CSIBCVector3D GetInterestPosition (  ) 

Return the position of the spotlight interest.

Returns:
CSIBCVector3D Interest position.

SI_Void SetInterestPosition ( CSIBCVector3D &  in_rValue  ) 

Change the position of the spotlight interest.

Parameters:
in_rValue  New interest position.
Returns:
SI_Void

SI_Float GetConeAngle (  ) 

Return the cone angle of the spotlight.

Returns:
SI_Float Cone angle.

SI_Void SetConeAngle ( SI_Float  in_fValue  ) 

Change the cone angle of the spotlight.

Parameters:
in_fValue  New cone angle.
Returns:
None

SI_Float GetSpreadAngle (  ) 

Return the spread angle of the spotlight.

Returns:
SI_Float Spread angle.

SI_Void SetSpreadAngle ( SI_Float  in_fValue  ) 

Change the spread angle of the spotlight.

Parameters:
in_fValue  New spread angle.
Returns:
SI_Void

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this light instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLLight.

Reimplemented in CSLCOLLADASpotLight.

virtual ETemplateType Type (  )  [virtual]

Get the template type

Returns:
ETemplateType the template type of the spotlight

Implements CSLTemplate.

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

Gets a handle on one of this light's parameters by using its name

Parameters:
in_szName  the name of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLLight.

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

Gets a handle on one of this light's parameters by using its name and type

Parameters:
in_szName  the name of the parameter to get the handle from
in_Type  the type of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLLight.

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