render::Light Class Reference

Representation of a light in the render world. More...

#include <Light.h>

Inheritance diagram for render::Light:

List of all members.

Public Member Functions
const render::Color &	getAmbientColor () const
f32	getAttenuationConstant () const
f32	getAttenuationLinear () const
f32	getAttenuationQuadric () const
f32	getAttenuationRange () const
const render::Color &	getDiffuseColor () const
LightType	getLightType ()
f32	getPowerScale () const
const render::Color &	getSpecularColor () const
f32	getSpotlightFalloff () const
f32	getSpotlightInnerAngle () const
f32	getSpotlightOuterAngle () const
bool	isVisible ()
	Light (const std::string &name)
	Light ()
Light &	operator= (const Light &other)
void	setAmbientColor (const render::Color &color)
void	setAmbientColor (f32 red, f32 green, f32 blue)
void	setAttenuation (f32 range, f32 constant, f32 linear, f32 quadratic)
void	setAttenuationConstant (f32 constant)
void	setAttenuationLinear (f32 linear)
void	setAttenuationQuadric (f32 quadratic)
void	setAttenuationRange (f32 range)
void	setDiffuseColor (f32 red, f32 green, f32 blue)
void	setDiffuseColor (const render::Color &color)
void	setLightType (LightType type)
void	setPowerScale (f32 power)
void	setSpecularColor (const render::Color &color)
void	setSpecularColor (f32 red, f32 green, f32 blue)
void	setSpotlightFalloff (f32 falloff)
void	setSpotlightInnerAngle (f32 innerAngle)
void	setSpotlightOuterAngle (f32 outerAngle)
void	setSpotlightRange (f32 innerAngle, f32 outerAngle, f32 falloff)
void	setVisible (bool visible)
	~Light ()
Private Member Functions
void	initProperties ()
Private Attributes
render::Color	mAmbient
f32	mAttenuationConst
f32	mAttenuationLinear
f32	mAttenuationQuad
render::Color	mDiffuse
LightType	mLightType
f32	mPowerScale
f32	mRange
render::Color	mSpecular
f32	mSpotFalloff
f32	mSpotInner
f32	mSpotOuter
bool	mVisible
Static Private Attributes
static u32	msNextGeneratedLightIndex = 0

---

Detailed Description

Representation of a light in the render world.

---

Constructor & Destructor Documentation

render::Light::Light

(

)

References initProperties(), scene::Node::mNodeType, and scene::NT_LIGHT.

render::Light::Light

(

const std::string &

name

)

References initProperties(), scene::Node::mNodeType, and scene::NT_LIGHT.

render::Light::~Light

(

)

---

Member Function Documentation

const render::Color & render::Light::getAmbientColor

(

)

const

References mAmbient.

f32 render::Light::getAttenuationConstant

(

)

const

References mAttenuationConst.

Referenced by render::ShaderParamData::getCurrentLightAttenuation().

f32 render::Light::getAttenuationLinear

(

)

const

References mAttenuationLinear.

Referenced by render::ShaderParamData::getCurrentLightAttenuation().

f32 render::Light::getAttenuationQuadric

(

)

const

References mAttenuationQuad.

Referenced by render::ShaderParamData::getCurrentLightAttenuation().

f32 render::Light::getAttenuationRange

(

)

const

References mRange.

Referenced by render::ShaderParamData::getCurrentLightAttenuation().

const render::Color & render::Light::getDiffuseColor

(

)

const

References mDiffuse.

Referenced by render::ShaderParamData::getCurrentLightDiffuseColour().

LightType render::Light::getLightType

(

)

References mLightType.

Referenced by render::ShaderParamData::getCurrentLightPositionObjectSpace().

f32 render::Light::getPowerScale

(

)

const

References mPowerScale.

const render::Color & render::Light::getSpecularColor

(

)

const

References mSpecular.

Referenced by render::ShaderParamData::getCurrentLightSpecularColour().

f32 render::Light::getSpotlightFalloff

(

)

const

References mSpotFalloff.

f32 render::Light::getSpotlightInnerAngle

(

)

const

References mSpotInner.

f32 render::Light::getSpotlightOuterAngle

(

)

const

References mSpotOuter.

void render::Light::initProperties

(

)

[private]

Reimplemented from scene::Node.

References render::Color::Black, render::LT_POINT, mAmbient, mAttenuationConst, mAttenuationLinear, mAttenuationQuad, mDiffuse, mLightType, mPowerScale, mRange, mSpecular, mSpotFalloff, mSpotInner, mSpotOuter, mVisible, and render::Color::White.

Referenced by Light().

bool render::Light::isVisible

(

)

References mVisible.

Light & render::Light::operator=

(

const Light &

other

)

[inline]

References mAmbient, mAttenuationConst, mAttenuationLinear, mAttenuationQuad, mDiffuse, mLightType, scene::Node::mModifiedAbsoluteTransform, scene::Node::mOrientation, scene::Node::mPosition, mPowerScale, mRange, scene::Node::mScale, mSpecular, mSpotFalloff, mSpotInner, mSpotOuter, and mVisible.

void render::Light::setAmbientColor	(	f32	red,
		f32	green,
		f32	blue
	)

References render::Color::B, render::Color::G, mAmbient, scene::Node::mModifiedAbsoluteTransform, and render::Color::R.

void render::Light::setAmbientColor

(

const render::Color &

color

)

References mAmbient, and scene::Node::mModifiedAbsoluteTransform.

void render::Light::setAttenuation	(	f32	range,
		f32	constant,
		f32	linear,
		f32	quadratic
	)

References mAttenuationConst, mAttenuationLinear, mAttenuationQuad, and mRange.

void render::Light::setAttenuationConstant

(

f32

constant

)

References mAttenuationConst.

void render::Light::setAttenuationLinear

(

f32

linear

)

References mAttenuationLinear.

void render::Light::setAttenuationQuadric

(

f32

quadratic

)

References mAttenuationQuad.

void render::Light::setAttenuationRange

(

f32

range

)

References mRange.

void render::Light::setDiffuseColor

(

const render::Color &

color

)

References mDiffuse.

void render::Light::setDiffuseColor	(	f32	red,
		f32	green,
		f32	blue
	)

References render::Color::B, render::Color::G, mDiffuse, and render::Color::R.

void render::Light::setLightType

(

LightType

type

)

References mLightType, and scene::Node::mModifiedAbsoluteTransform.

void render::Light::setPowerScale

(

f32

power

)

References mPowerScale.

void render::Light::setSpecularColor	(	f32	red,
		f32	green,
		f32	blue
	)

References render::Color::B, render::Color::G, mSpecular, and render::Color::R.

void render::Light::setSpecularColor

(

const render::Color &

color

)

References mSpecular.

void render::Light::setSpotlightFalloff

(

f32

falloff

)

References render::LT_SPOTLIGHT, mLightType, and mSpotFalloff.

void render::Light::setSpotlightInnerAngle

(

f32

innerAngle

)

References render::LT_SPOTLIGHT, mLightType, and mSpotInner.

void render::Light::setSpotlightOuterAngle

(

f32

outerAngle

)

References render::LT_SPOTLIGHT, mLightType, and mSpotOuter.

void render::Light::setSpotlightRange	(	f32	innerAngle,
		f32	outerAngle,
		f32	falloff
	)

References render::LT_SPOTLIGHT, mLightType, mSpotFalloff, mSpotInner, and mSpotOuter.

void render::Light::setVisible

(

bool

visible

)

References mVisible.

---

Member Data Documentation

render::Color render::Light::mAmbient [private]

Referenced by getAmbientColor(), initProperties(), operator=(), and setAmbientColor().

f32 render::Light::mAttenuationConst [private]

Referenced by getAttenuationConstant(), initProperties(), operator=(), setAttenuation(), and setAttenuationConstant().

f32 render::Light::mAttenuationLinear [private]

Referenced by getAttenuationLinear(), initProperties(), operator=(), setAttenuation(), and setAttenuationLinear().

f32 render::Light::mAttenuationQuad [private]

Referenced by getAttenuationQuadric(), initProperties(), operator=(), setAttenuation(), and setAttenuationQuadric().

render::Color render::Light::mDiffuse [private]

Referenced by getDiffuseColor(), initProperties(), operator=(), and setDiffuseColor().

LightType render::Light::mLightType [private]

Referenced by getLightType(), initProperties(), operator=(), setLightType(), setSpotlightFalloff(), setSpotlightInnerAngle(), setSpotlightOuterAngle(), and setSpotlightRange().

f32 render::Light::mPowerScale [private]

Referenced by getPowerScale(), initProperties(), operator=(), and setPowerScale().

f32 render::Light::mRange [private]

Referenced by getAttenuationRange(), initProperties(), operator=(), setAttenuation(), and setAttenuationRange().

u32 render::Light::msNextGeneratedLightIndex = 0 [static, private]

render::Color render::Light::mSpecular [private]

Referenced by getSpecularColor(), initProperties(), operator=(), and setSpecularColor().

f32 render::Light::mSpotFalloff [private]

Referenced by getSpotlightFalloff(), initProperties(), operator=(), setSpotlightFalloff(), and setSpotlightRange().

f32 render::Light::mSpotInner [private]

Referenced by getSpotlightInnerAngle(), initProperties(), operator=(), setSpotlightInnerAngle(), and setSpotlightRange().

f32 render::Light::mSpotOuter [private]

Referenced by getSpotlightOuterAngle(), initProperties(), operator=(), setSpotlightOuterAngle(), and setSpotlightRange().

bool render::Light::mVisible [private]

Referenced by initProperties(), isVisible(), operator=(), and setVisible().

---

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

• E:/Programming/MyProject/K_Game_hg/GameEngine/include/render/Light.h
• E:/Programming/MyProject/K_Game_hg/GameEngine/src/render/Light.cpp