#include <OgreLight.hh>

Public Member Functions
virtual	~OgreLight ()

virtual double	AttenuationConstant () const
	Get the attenuation constant value. More...

virtual double	AttenuationLinear () const
	Get the attenuation linear value. More...

virtual double	AttenuationQuadratic () const
	Get the attenuation quadratic value. More...

virtual double	AttenuationRange () const
	Get the attenuation ranage. More...

virtual bool	CastShadows () const
	Determine if this light cast shadows. More...

virtual void	Destroy ()
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...

virtual math::Color	DiffuseColor () const
	Get the diffuse color. More...

virtual Ogre::Light *	Light () const

virtual void	SetAttenuationConstant (double _value)
	Set the attenuation constant value. More...

virtual void	SetAttenuationLinear (double _value)
	Set the attenuation linear value. More...

virtual void	SetAttenuationQuadratic (double _value)
	Set the attenuation quadratic value. More...

virtual void	SetAttenuationRange (double _range)
	Set the attenuation ranage. More...

virtual void	SetCastShadows (bool _castShadows)
	Specify if this light should cast shadows. More...

virtual void	SetDiffuseColor (const math::Color &_color)
	Set the diffuse color. More...

virtual void	SetSpecularColor (const math::Color &_color)
	Set the specular color. More...

virtual math::Color	SpecularColor () const
	Get the specular color. More...

Public Member Functions inherited from BaseLight< OgreNode >
virtual	~BaseLight ()

virtual void	SetDiffuseColor (double _r, double _g, double _b, double _a=1.0)
	Set the diffuse color. More...

virtual void	SetSpecularColor (double _r, double _g, double _b, double _a=1.0)
	Set the specular color. More...

Public Member Functions inherited from Light
virtual	~Light ()
	Deconstructor. More...

Public Member Functions inherited from Node
virtual	~Node ()
	Deconstructor. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. More...

Public Member Functions inherited from OgreNode
virtual	~OgreNode ()

virtual bool	HasParent () const
	Determine if this Geometry is attached to a Visual. More...

virtual Ogre::SceneNode *	Node () const

virtual VisualPtr	Parent () const
	Get the parent Visual. More...

Public Member Functions inherited from BaseNode< OgreObject >
virtual	~BaseNode ()

virtual math::Pose3d	LocalPose () const
	Get the local pose. More...

virtual math::Vector3d	LocalPosition () const
	Get the local position. More...

virtual math::Quaterniond	LocalRotation () const
	Get the local rotation. More...

virtual math::Vector3d	Origin () const
	Get position of origin. More...

virtual void	RemoveParent ()
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...

virtual void	SetLocalPose (const math::Pose3d &_pose)
	Set the local pose. More...

virtual void	SetLocalPosition (double _x, double _y, double _z)
	Set the local position. More...

virtual void	SetLocalPosition (const math::Vector3d &_position)
	Set the local position. More...

virtual void	SetLocalRotation (double _r, double _p, double _y)
	Set the local rotation. More...

virtual void	SetLocalRotation (double _w, double _x, double _y, double _z)
	Set the local rotation. More...

virtual void	SetLocalRotation (const math::Quaterniond &_rotation)
	Set the local rotation. More...

virtual void	SetOrigin (double _x, double _y, double _z)
	Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void	SetOrigin (const math::Vector3d &_origin)
	Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void	SetWorldPose (const math::Pose3d &_pose)
	Set the world pose. More...

virtual void	SetWorldPosition (double _x, double _y, double _z)
	Set the world position. More...

virtual void	SetWorldPosition (const math::Vector3d &_position)
	Set the world position. More...

virtual void	SetWorldRotation (double _r, double _p, double _y)
	Set the world rotation. More...

virtual void	SetWorldRotation (double _w, double _x, double _y, double _z)
	Set the world rotation. More...

virtual void	SetWorldRotation (const math::Quaterniond &_rotation)
	Set the world rotation. More...

virtual math::Pose3d	WorldPose () const
	Get the world pose. More...

virtual math::Vector3d	WorldPosition () const
	Get the world position. More...

virtual math::Quaterniond	WorldRotation () const
	Get the world rotation. More...

virtual math::Pose3d	WorldToLocal (const math::Pose3d &_pose) const
	Convert given world pose to local pose. More...

Public Member Functions inherited from OgreObject
virtual	~OgreObject ()

virtual ScenePtr	Scene () const
	Get the Scene that created this object. More...

Public Member Functions inherited from BaseObject
virtual	~BaseObject ()

virtual unsigned int	Id () const
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual std::string	Name () const
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual void	PreRender ()
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...

Public Member Functions inherited from enable_shared_from_this< BaseObject >
T	enable_shared_from_this (T... args)

T	~enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

Protected Member Functions
	OgreLight ()

virtual void	Init ()

Protected Member Functions inherited from BaseLight< OgreNode >
	BaseLight ()

virtual void	Reset ()

Protected Member Functions inherited from OgreNode
	OgreNode ()

virtual void	Load ()

virtual math::Pose3d	RawLocalPose () const

virtual math::Vector3d	RawLocalPosition () const

virtual math::Quaterniond	RawLocalRotation () const

virtual void	SetParent (OgreVisualPtr _parent)

virtual void	SetRawLocalPose (const math::Pose3d &_Pose3d)

virtual void	SetRawLocalPosition (const math::Vector3d &_position)

virtual void	SetRawLocalRotation (const math::Quaterniond &_rotation)

Protected Member Functions inherited from BaseNode< OgreObject >
	BaseNode ()

Protected Member Functions inherited from OgreObject
	OgreObject ()

Protected Member Functions inherited from BaseObject
	BaseObject ()

Protected Attributes
double	attenConstant

double	attenLinear

double	attenQuadratic

double	attenRange

Ogre::Light *	ogreLight

Ogre::Light::LightTypes	ogreLightType

Protected Attributes inherited from OgreNode
Ogre::SceneNode *	ogreNode

OgreVisualPtr	parent

Protected Attributes inherited from BaseNode< OgreObject >
math::Vector3d	origin

Protected Attributes inherited from OgreObject
OgreScenePtr	scene

Protected Attributes inherited from BaseObject
unsigned int	id

std::string	name

Constructor & Destructor Documentation

◆ OgreLight()

OgreLight ( )

protected

◆ ~OgreLight()

virtual ~OgreLight ( )

virtual

Member Function Documentation

◆ AttenuationConstant()

virtual double AttenuationConstant ( ) const

virtual

Get the attenuation constant value.

Returns: The attenuation constant value

Implements Light.

◆ AttenuationLinear()

virtual double AttenuationLinear ( ) const

virtual

Get the attenuation linear value.

Returns: The attenuation linear value

Implements Light.

◆ AttenuationQuadratic()

virtual double AttenuationQuadratic ( ) const

virtual

Get the attenuation quadratic value.

Returns: The attenuation quadratic value

Implements Light.

◆ AttenuationRange()

virtual double AttenuationRange ( ) const

virtual

Get the attenuation ranage.

Returns: The attenuation ranage

Implements Light.

◆ CastShadows()

virtual bool CastShadows ( ) const

virtual

Determine if this light cast shadows.

Returns: True if this light cast shadows

Implements Light.

◆ Destroy()

virtual void Destroy ( )

virtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Reimplemented from OgreNode.

◆ DiffuseColor()

virtual math::Color DiffuseColor ( ) const

virtual

Get the diffuse color.

Returns: The diffuse color

Implements Light.

◆ Init()

virtual void Init ( )

protectedvirtual

Reimplemented from OgreNode.

◆ Light()

virtual Ogre::Light* Light ( ) const

virtual

◆ SetAttenuationConstant()

virtual void SetAttenuationConstant ( double _value )

virtual

Set the attenuation constant value.

Parameters

[in] _value New attenuation constant value

Implements BaseLight< OgreNode >.

◆ SetAttenuationLinear()

virtual void SetAttenuationLinear ( double _value )

virtual

Set the attenuation linear value.

Parameters

[in] _value New attenuation linear value

Implements BaseLight< OgreNode >.

◆ SetAttenuationQuadratic()

virtual void SetAttenuationQuadratic ( double _value )

virtual

Set the attenuation quadratic value.

Parameters

[in] _value New attenuation quadratic value

Implements BaseLight< OgreNode >.

◆ SetAttenuationRange()

virtual void SetAttenuationRange ( double _range )

virtual

Set the attenuation ranage.

Parameters

[in] _value New attenuation ranage

Implements BaseLight< OgreNode >.

◆ SetCastShadows()

virtual void SetCastShadows ( bool _castShadows )

virtual

Specify if this light should cast shadows.

Parameters

[in] _castShadows True if this light cast shadows

Implements BaseLight< OgreNode >.

◆ SetDiffuseColor()

virtual void SetDiffuseColor ( const math::Color & _color )

virtual

Set the diffuse color.

Parameters

[in] _color New diffuse color

Implements BaseLight< OgreNode >.

◆ SetSpecularColor()

virtual void SetSpecularColor ( const math::Color & _color )

virtual

Set the specular color.

Parameters

[in] _color New specular color

Implements BaseLight< OgreNode >.

◆ SpecularColor()

virtual math::Color SpecularColor ( ) const

virtual

Get the specular color.

Returns: The specular color

Implements Light.

Member Data Documentation

◆ attenConstant

double attenConstant

protected

◆ attenLinear

double attenLinear

protected

◆ attenQuadratic

double attenQuadratic

protected

◆ attenRange

double attenRange

protected

◆ ogreLight

Ogre::Light* ogreLight

protected

◆ ogreLightType

Ogre::Light::LightTypes ogreLightType

protected

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

OgreLight.hh

Ignition Rendering

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ OgreLight()

◆ ~OgreLight()

Member Function Documentation

◆ AttenuationConstant()

◆ AttenuationLinear()

◆ AttenuationQuadratic()

◆ AttenuationRange()

◆ CastShadows()

◆ Destroy()

◆ DiffuseColor()

◆ Init()

◆ Light()

◆ SetAttenuationConstant()

◆ SetAttenuationLinear()

◆ SetAttenuationQuadratic()

◆ SetAttenuationRange()

◆ SetCastShadows()

◆ SetDiffuseColor()

◆ SetSpecularColor()

◆ SpecularColor()

Member Data Documentation

◆ attenConstant

◆ attenLinear

◆ attenQuadratic

◆ attenRange

◆ ogreLight

◆ ogreLightType