class LightObject

Defined in: C4LightObjects.h

The LightObject class encapsulates data pertaining to a light source.

Definition

class LightObject : public Object

Member Functions

`LightObject::GetLightType`	Returns the specific type of a light.
`LightObject::GetBaseLightType`	Returns the base type of a light.
`LightObject::GetLightColor`	Returns the light color.
`LightObject::SetLightColor`	Sets the light color.
`LightObject::GetLightFlags`	Returns the light flags.
`LightObject::SetLightFlags`	Sets the light flags.

Constructor

LightObject(LightType type, LightType base, const ColorRGB& color);

The constructor has protected access. The LightObject class can only exist as the base class for another class.

Parameters

`type`	The type of the light source. See below for a list of possible types.
`base`	The base type of the light source. This should be `kLightInfinite` or `kLightPoint`.
`color`	The color of light emitted by the light source.

Description

`kLightInfinite`	An infinite light.
`kLightDepth`	An infinite light with a shadow map.
`kLightLandscape`	An infinite light with a large-scale multi-resolution shadow map.
`kLightPoint`	A point light.
`kLightCube`	A point light with a projected cube shadow texture.
`kLightSpot`	A spot light with a projected 2D shadow texture.

Base Classes

Object A LightObject is an object that can be shared by multiple light nodes.