SO3::SLight Class Reference

#include <SO3Light.h>

Inheritance diagram for SO3::SLight:

List of all members.

Public Types
enum	LightType { SO3_POINT_LIGHT = 0, SO3_DIRECTIONAL_LIGHT = 1, SO3_SPOTLIGHT_LIGHT = 2 }
Public Member Functions
	SLight (SScene *parent, std::string lightName)
	~SLight ()
Ogre::Light *	GetOgreLightPointer ()
void	SetDiffuseColour (int diffuseColor)
int	GetDiffuseColour ()
void	SetSpecularColour (int specularColor)
int	GetSpecularColour ()
void	SetPowerScale (float powerScale)
float	GetPowerScale ()
void	SetVisible (bool isVisible)
bool	GetVisible ()
void	SetAttenuation (float range, float constant, float linear, float quadratic)
void	SetAttenuation (float range)
Ogre::Vector4	GetAttenuation ()
void	SLight::SetShadowFarDistance (float distance)
float	GetShadowFarDistance ()
void	SetType (LightType type)
LightType	GetType ()
void	SetSpotlightInnerAngle (float radianAngle)
float	GetSpotlightInnerAngle ()
void	SetSpotlightOuterAngle (float radianAngle)
float	GetSpotlightOuterAngle ()
void	SetSpotlightFalloff (float value)
float	GetSpotlightFalloff ()
virtual void	SetCastShadows (bool castShadows)
virtual bool	GetCastShadows ()
virtual void	SetRenderingDistance (float distance)
virtual float	GetRenderingDistance ()
virtual Ogre::Vector3	GetBoundingBoxSize (bool childs=false)
virtual Ogre::Vector3	GetBoundingBoxCenter (bool childs=false)

---

Detailed Description

Definition at line 45 of file SO3Light.h.

---

Member Enumeration Documentation

enum SO3::SLight::LightType

Enumerator:

SO3_POINT_LIGHT
SO3_DIRECTIONAL_LIGHT
SO3_SPOTLIGHT_LIGHT

Definition at line 48 of file SO3Light.h.

---

Constructor & Destructor Documentation

SO3::SLight::SLight	(	SScene *	parent,
		std::string	lightName
	)

Constructor

Definition at line 15 of file SO3Light.cpp.

SO3::SLight::~SLight

(

)

Definition at line 31 of file SO3Light.cpp.

---

Member Function Documentation

Ogre::Vector4 SO3::SLight::GetAttenuation

(

)

Definition at line 94 of file SO3Light.cpp.

Ogre::Vector3 SO3::SLight::GetBoundingBoxCenter

(

bool

childs = false

)

[virtual]

Remarks:

: SLight implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 180 of file SO3Light.cpp.

Ogre::Vector3 SO3::SLight::GetBoundingBoxSize

(

bool

childs = false

)

[virtual]

Remarks:

: SLight implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 172 of file SO3Light.cpp.

bool SO3::SLight::GetCastShadows

(

)

[virtual]

Remarks:

: SLight implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 157 of file SO3Light.cpp.

int SO3::SLight::GetDiffuseColour

(

)

Definition at line 49 of file SO3Light.cpp.

Ogre::Light * SO3::SLight::GetOgreLightPointer

(

)

Definition at line 39 of file SO3Light.cpp.

float SO3::SLight::GetPowerScale

(

)

Definition at line 69 of file SO3Light.cpp.

float SO3::SLight::GetRenderingDistance

(

)

[virtual]

Remarks:

: SLight implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 167 of file SO3Light.cpp.

float SO3::SLight::GetShadowFarDistance

(

)

Definition at line 107 of file SO3Light.cpp.

int SO3::SLight::GetSpecularColour

(

)

Definition at line 59 of file SO3Light.cpp.

float SO3::SLight::GetSpotlightFalloff

(

)

Definition at line 147 of file SO3Light.cpp.

float SO3::SLight::GetSpotlightInnerAngle

(

)

Definition at line 127 of file SO3Light.cpp.

float SO3::SLight::GetSpotlightOuterAngle

(

)

Definition at line 137 of file SO3Light.cpp.

SLight::LightType SO3::SLight::GetType

(

)

Definition at line 117 of file SO3Light.cpp.

bool SO3::SLight::GetVisible

(

)

Reimplemented from SO3::SNode.

Definition at line 79 of file SO3Light.cpp.

void SO3::SLight::SetAttenuation

(

float

range

)

Set attenuation parameters automatically, from the range value, and using the standart formula

Remarks:

approximation is used, but it's good enought for most of the cases.

Definition at line 89 of file SO3Light.cpp.

void SO3::SLight::SetAttenuation	(	float	range,
		float	constant,
		float	linear,
		float	quadratic
	)

Definition at line 84 of file SO3Light.cpp.

void SO3::SLight::SetCastShadows

(

bool

castShadows

)

[virtual]

Remarks:

: SLight implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 152 of file SO3Light.cpp.

void SO3::SLight::SetDiffuseColour

(

int

diffuseColor

)

Definition at line 44 of file SO3Light.cpp.

void SO3::SLight::SetPowerScale

(

float

powerScale

)

Definition at line 64 of file SO3Light.cpp.

void SO3::SLight::SetRenderingDistance

(

float

distance

)

[virtual]

Remarks:

: SLight implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 162 of file SO3Light.cpp.

void SO3::SLight::SetSpecularColour

(

int

specularColor

)

Definition at line 54 of file SO3Light.cpp.

void SO3::SLight::SetSpotlightFalloff

(

float

value

)

Definition at line 142 of file SO3Light.cpp.

void SO3::SLight::SetSpotlightInnerAngle

(

float

radianAngle

)

Definition at line 122 of file SO3Light.cpp.

void SO3::SLight::SetSpotlightOuterAngle

(

float

radianAngle

)

Definition at line 132 of file SO3Light.cpp.

void SO3::SLight::SetType

(

LightType

type

)

Definition at line 112 of file SO3Light.cpp.

void SO3::SLight::SetVisible

(

bool

isVisible

)

Definition at line 74 of file SO3Light.cpp.

void SO3::SLight::SLight::SetShadowFarDistance

(

float

distance

)

---

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

• SO3Engine/SO3SceneGraph/SO3Light.h
• SO3Engine/SO3SceneGraph/SO3Light.cpp