# CSLLight Class Reference

`#include <Light.h>`

Inheritance diagram for CSLLight:

List of all members.

## Public Member Functions
virtual SI_Error | Synchronize ()
virtual CSLAnimatableType * | ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType * | ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
virtual | ~CSLLight ()
CSIBCColorf | GetColor ()
SI_Void | SetColor (CSIBCColorf &in_rColor)
CSIBCVector3D | GetPosition ()
SI_Void | SetPosition (CSIBCVector3D &in_rValue)
CSLConstraint * | AddConstraint (CSLConstraint::EConstraintType in_ConstraintType)
CSLLightInfo * | CreateLightInfo ()
SI_Error | DestroyLightInfo ()
CSLLightInfo * | ConnectLightInfo (CSLLightInfo *in_pToConnect)
CSLLightInfo * | LightInfo ()

## Detailed Description

Base class for lights (see the SI_Light template reference).

## Constructor & Destructor Documentation

virtual ~CSLLight | ( |  | ) | `[virtual]`

Destructor

## Member Function Documentation

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

Reimplemented in CSLCOLLADASpotLight, CSLDirectionalLight, CSLInfiniteLight, CSLPointLight, and CSLSpotLight.

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

Reimplemented in CSLDirectionalLight, and CSLSpotLight.

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_szParameterName | 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 CSLTemplate.

Reimplemented in CSLDirectionalLight, and CSLSpotLight.

CSIBCColorf GetColor | ( |  | ) |

Return the color of the light.

Returns:
  CSIBCColorf Light color.

SI_Void SetColor | ( | CSIBCColorf & | in_rColor | ) |

Change the color of the light.

Parameters:

  | in_rColor | New light color.

Returns:
  SI_Void

CSIBCVector3D GetPosition | ( |  | ) |

Return the position of the light.

Returns:
  CSIBCVector3D Light position.

SI_Void SetPosition | ( | CSIBCVector3D & | in_rValue | ) |

Change the position of the light.

Parameters:

  | in_rValue | New light position.

Returns:
  SI_Void

CSLConstraint* AddConstraint | ( | CSLConstraint::EConstraintType | in_ConstraintType | ) | `[virtual]`

Add a new constraint to the light.

Parameters:

  | in_ConstraintType | Type of constraint to create.

Returns:
  CSLConstraint* Pointer to the newly created constraint object.

Implements CSLConstrainableType.

CSLLightInfo* CreateLightInfo | ( |  | ) |

Creates a new light info

Returns:
  CSLLightInfo* The new light info or null if there's already one

SI_Error DestroyLightInfo | ( |  | ) |

Destroys the light info

Returns:
  SI_Error Whether or not the light info could be destroyed

CSLLightInfo* ConnectLightInfo | ( | CSLLightInfo * | in_pToConnect | ) |

Connects an exisiting light info

Parameters:

  | in_pToConnect | Pointer to the light info to use

Returns:
  CSLLightInfo* The added light info or null if there's already one

CSLLightInfo* LightInfo | ( |  | ) |

Gets a pointer to the light info

Returns:
  CSLLightInfo* Pointer to the light info

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

- Light.h