Ogre::Light

Ogre::Light Class Reference

Representation of a dynamic light source in the scene. More...

#include <OgreLight.h>

Inheritance diagram for Ogre::Light:

[legend]List of all members.

Public Types

enum LightTypes { LT_POINT = 0, LT_DIRECTIONAL = 1, LT_SPOTLIGHT = 2 }

Defines the type of light. More...

typedef std::vector< ShadowRenderable * > ShadowRenderableList

typedef VectorIterator< ShadowRenderableList > ShadowRenderableListIterator

Public Member Functions

void _calcTempSquareDist (const Vector3 &worldPos)

internal method for calculating current squared distance from some world position

Light ()

Default constructor (for Python mainly).

Light (const String &name)

Normal constructor.

~Light ()

Standard destructor.

void setType (LightTypes type)

Sets the type of light - see LightTypes for more info.

LightTypes getType (void) const

Returns the light type.

void setDiffuseColour (Real red, Real green, Real blue)

Sets the colour of the diffuse light given off by this source.

void setDiffuseColour (const ColourValue &colour)

Sets the colour of the diffuse light given off by this source.

const ColourValue & getDiffuseColour (void) const

Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info).

void setSpecularColour (Real red, Real green, Real blue)

Sets the colour of the specular light given off by this source.

void setSpecularColour (const ColourValue &colour)

Sets the colour of the specular light given off by this source.

const ColourValue & getSpecularColour (void) const

Returns the colour of specular light given off by this light source.

void setAttenuation (Real range, Real constant, Real linear, Real quadratic)

Sets the attenuation parameters of the light source i.e.

Real getAttenuationRange (void) const

Returns the absolute upper range of the light.

Real getAttenuationConstant (void) const

Returns the constant factor in the attenuation formula.

Real getAttenuationLinear (void) const

Returns the linear factor in the attenuation formula.

Real getAttenuationQuadric (void) const

Returns the quadric factor in the attenuation formula.

void setPosition (Real x, Real y, Real z)

Sets the position of the light.

void setPosition (const Vector3 &vec)

Sets the position of the light.

const Vector3 & getPosition (void) const

Returns the position of the light.

void setDirection (Real x, Real y, Real z)

Sets the direction in which a light points.

void setDirection (const Vector3 &vec)

Sets the direction in which a light points.

const Vector3 & getDirection (void) const

Returns the light's direction.

void setSpotlightRange (const Radian &innerAngle, const Radian &outerAngle, Real falloff=1.0)

Sets the range of a spotlight, i.e.

const Radian & getSpotlightInnerAngle (void) const

Returns the angle covered by the spotlights inner cone.

const Radian & getSpotlightOuterAngle (void) const

Returns the angle covered by the spotlights outer cone.

Real getSpotlightFalloff (void) const

Returns the falloff between the inner and outer cones of the spotlight.

void setSpotlightInnerAngle (const Radian &val)

Sets the angle covered by the spotlights inner cone.

void setSpotlightOuterAngle (const Radian &val)

Sets the angle covered by the spotlights outer cone.

void setSpotlightFalloff (Real val)

Sets the falloff between the inner and outer cones of the spotlight.

void setPowerScale (Real power)

Set a scaling factor to indicate the relative power of a light.

Real getPowerScale (void) const

Set the scaling factor which indicates the relative power of a light.

void _notifyAttached (Node *parent, bool isTagPoint=false)