Eidolon
Public Member Functions | Protected Attributes | List of all members
OgreLight Class Reference

#include <OgreRenderTypes.h>

Inheritance diagram for OgreLight:
Inheritance graph
Collaboration diagram for OgreLight:
Collaboration graph

Public Member Functions

 OgreLight (Ogre::Light *light, OgreRenderScene *scene)
 
virtual ~OgreLight ()
 
virtual void setPosition (vec3 &v)
 Set the position for this light, only meaningful for point and spot lights. More...
 
virtual void setDirection (vec3 &v)
 Set the direction to emit light at, only meaningful for directional and spot lights. More...
 
virtual void setDiffuse (const color &c)
 Set the diffuse color to emit. More...
 
virtual void setSpecular (const color &c)
 Set the specular color to reflect. More...
 
virtual void setDirectional ()
 Make this a directional light, illuminating all scene objects in the set direction. More...
 
virtual void setPoint ()
 Make this a point light, illuminating all objects within range as defined by the attenuation settings. More...
 
virtual void setSpotlight (real radsInner, real radsOuter, real falloff=1.0f)
 Make this a spot light with the given beam angles and falloff values. More...
 
virtual void setAttenuation (real range, real constant=0.0f, real linear=1.0f, real quad=0.0f)
 Set the attenuation values for spot and point lights. More...
 
virtual void setVisible (bool isVisible)
 Set whether this light is currently illuminating or not. More...
 
virtual bool isVisible () const
 Returns true if this light is actively illuminating the scene. More...
 
- Public Member Functions inherited from Light
 Light ()
 
virtual ~Light ()
 

Protected Attributes

Ogre::Light * light
 
OgreRenderScenescene
 

Constructor & Destructor Documentation

◆ OgreLight()

OgreLight ( Ogre::Light *  light,
OgreRenderScene scene 
)
inline

◆ ~OgreLight()

~OgreLight ( )
virtual

Member Function Documentation

◆ isVisible()

virtual bool isVisible ( ) const
inlinevirtual

Returns true if this light is actively illuminating the scene.

Reimplemented from Light.

Here is the caller graph for this function:

◆ setAttenuation()

virtual void setAttenuation ( real  range,
real  constant = 0.0f,
real  linear = 1.0f,
real  quad = 0.0f 
)
inlinevirtual

Set the attenuation values for spot and point lights.

Reimplemented from Light.

Here is the caller graph for this function:

◆ setDiffuse()

virtual void setDiffuse ( const color c)
inlinevirtual

Set the diffuse color to emit.

Reimplemented from Light.

Here is the call graph for this function:

◆ setDirection()

virtual void setDirection ( vec3 v)
inlinevirtual

Set the direction to emit light at, only meaningful for directional and spot lights.

Reimplemented from Light.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setDirectional()

virtual void setDirectional ( )
inlinevirtual

Make this a directional light, illuminating all scene objects in the set direction.

Reimplemented from Light.

◆ setPoint()

virtual void setPoint ( )
inlinevirtual

Make this a point light, illuminating all objects within range as defined by the attenuation settings.

Reimplemented from Light.

Here is the caller graph for this function:

◆ setPosition()

virtual void setPosition ( vec3 v)
inlinevirtual

Set the position for this light, only meaningful for point and spot lights.

Reimplemented from Light.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setSpecular()

virtual void setSpecular ( const color c)
inlinevirtual

Set the specular color to reflect.

Reimplemented from Light.

Here is the call graph for this function:

◆ setSpotlight()

virtual void setSpotlight ( real  radsInner,
real  radsOuter,
real  falloff = 1.0f 
)
inlinevirtual

Make this a spot light with the given beam angles and falloff values.

Reimplemented from Light.

◆ setVisible()

virtual void setVisible ( bool  isVisible)
inlinevirtual

Set whether this light is currently illuminating or not.

Reimplemented from Light.

Here is the caller graph for this function:

Member Data Documentation

◆ light

Ogre::Light* light
protected

◆ scene

OgreRenderScene* scene
protected

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