CSLPointLight Class Reference

Describes a point light. More...

#include <PointLight.h>

Inheritance diagram for CSLPointLight:

CSLLight CSLPrimitive CSLConstrainableType CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLPointLight (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLPointLight ()
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

Describes a point light.

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  scene to add this point light to
[in]  in_pModel  model to add this light to
[in]  in_pTemplate  IO layer template to connect to
Returns:
an instance of CSLPointLight

virtual ~CSLPointLight (  )  [virtual]

Destructor

Member Function Documentation

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this light instance with its IO layer representation

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

Reimplemented from CSLLight.

virtual ETemplateType Type (  )  [virtual]

Returns the template type of the light

Return values:
CSLTemplate::SI_POINT_LIGHT  the template type

Implements CSLTemplate.

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