OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Light Class Reference

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

#include <OgreLight.h>

+ Inheritance diagram for Ogre::Light:
+ Collaboration diagram for Ogre::Light:

Public Types

enum  LightTypes { LT_POINT = 0, LT_DIRECTIONAL = 1, LT_SPOTLIGHT = 2 }
 Defines the type of light. More...
 
typedef FastArray
< MovableObject * > 
MovableObjectArray
 SceneManager::cullFrustum More...
 

Public Member Functions

 Light (IdType id, ObjectMemoryManager *objectMemoryManager)
 Normal constructor. More...
 
 ~Light ()
 Standard destructor. More...
 
void _calcTempSquareDist (const Vector3 &worldPos)
 Internal method for calculating current squared distance from some world position. More...
 
Real _deriveShadowFarClipDistance (const Camera *maincam) const
 Derive a shadow camera far distance from either the light, or from the main camera if the light doesn't have its own setting. More...
 
Real _deriveShadowNearClipDistance (const Camera *maincam) const
 Derive a shadow camera near distance from either the light, or from the main camera if the light doesn't have its own setting. More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
const Matrix4_getParentNodeFullTransform (void) const
 Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyAttached (Node *parent)
 Internal method called to notify the object that it has been attached to a node. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyParentNodeMemoryChanged (void)
 Node::_callMemoryChangeListeners More...
 
virtual void _notifyStaticDirty (void) const
 Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
 
void _setCachedAabbOutOfDate (void)
 
virtual void _updateCustomGpuParameter (uint16 paramIndex, const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Light knows. More...
 
virtual void _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode if attached. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
Vector4 getAs4DVector (void) const
 
Real getAttenuationConstant (void) const
 Returns the constant factor in the attenuation formula. More...
 
Real getAttenuationLinear (void) const
 Returns the linear factor in the attenuation formula. More...
 
Real getAttenuationQuadric (void) const
 Returns the quadric factor in the attenuation formula. More...
 
Real getAttenuationRange (void) const
 Returns the absolute upper range of the light. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
const FastArray< unsigned char > & getCurrentMaterialLod (void) const
 
const Vector4getCustomParameter (uint16 index) const
 Gets the custom value associated with this Light at the given index. More...
 
Vector3 getDerivedDirection (void) const
 Retrieves the direction of the light including any transform from nodes it is attached to. More...
 
Vector3 getDerivedDirectionUpdated (void) const
 
const ColourValuegetDiffuseColour (void) const
 Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info). More...
 
Vector3 getDirection (void) const
 Returns the light's direction. More...
 
IdType getId () const
 Get the unique id of this object. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
const StringgetMovableType (void) const
 Returns the type name of this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 
Real getPowerScale (void) const
 Set the scaling factor which indicates the relative power of a light. More...
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
Real getShadowFarClipDistance () const
 Get the far clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
Real getShadowFarDistance (void) const
 Gets the maximum distance away from the camera that shadows by this light will be visible. More...
 
Real getShadowFarDistanceSquared (void) const
 
Real getShadowNearClipDistance () const
 Get the near clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
const ColourValuegetSpecularColour (void) const
 Returns the colour of specular light given off by this light source. More...
 
Real getSpotlightFalloff (void) const
 Returns the falloff between the inner and outer cones of the spotlight. More...
 
const RadiangetSpotlightInnerAngle (void) const
 Returns the angle covered by the spotlights inner cone. More...
 
Real getSpotlightNearClipDistance () const
 Get the near clip plane distance to be used by spotlights that use light clipping. More...
 
const RadiangetSpotlightOuterAngle (void) const
 Returns the angle covered by the spotlights outer cone. More...
 
LightTypes getType (void) const
 Returns the light type. More...
 
uint32 getTypeFlags (void) const
 Override to return specific type flag. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 InstancingTheadedCullingMethod, More...
 
bool isAttached (void) const
 Returns true if this object is attached to a Node. More...
 
bool isCachedAabbOutOfDate () const
 
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
bool isInLightRange (const Ogre::Sphere &sphere) const
 Check whether a sphere is included in the lighted area of the light. More...
 
bool isInLightRange (const Ogre::AxisAlignedBox &container) const
 Check whether a bounding box is included in the lighted area of the light. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. setStatic. More...
 
bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
bool operator() (const IdObject *left, const IdObject *right)
 
bool operator() (const IdObject &left, const IdObject &right)
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void resetShadowFarDistance (void)
 Tells the light to use the shadow far distance of the SceneManager. More...
 
void setAttenuation (Real range, Real constant, Real linear, Real quadratic)
 Sets the attenuation parameters of the light source i.e. More...
 
void setAttenuationBasedOnRadius (Real radius, Real lumThreshold)
 Sets the attenuation parameters (range, constant, linear & quadratic,. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setCustomParameter (uint16 index, const Vector4 &value)
 Sets a custom parameter for this Light, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
 
virtual void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setDiffuseColour (Real red, Real green, Real blue)
 Sets the colour of the diffuse light given off by this source. More...
 
void setDiffuseColour (const ColourValue &colour)
 Sets the colour of the diffuse light given off by this source. More...
 
void setDirection (const Vector3 &vec)
 Sets the direction in which a light points. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box for this object. More...
 
void setName (const String &name)
 Sets a custom name for this node. More...
 
void setPowerScale (Real power)
 Set a scaling factor to indicate the relative power of a light. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
void setShadowFarClipDistance (Real farClip)
 Set the far clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
void setShadowFarDistance (Real distance)
 Sets the maximum distance away from the camera that shadows by this light will be visible. More...
 
void setShadowNearClipDistance (Real nearClip)
 Set the near clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
void setSpecularColour (Real red, Real green, Real blue)
 Sets the colour of the specular light given off by this source. More...
 
void setSpecularColour (const ColourValue &colour)
 Sets the colour of the specular light given off by this source. More...
 
void setSpotAabb (void)
 Sets the Aabb (local space) for this light when it's of type spot. More...
 
void setSpotlightFalloff (Real val)
 Sets the falloff between the inner and outer cones of the spotlight. More...
 
void setSpotlightInnerAngle (const Radian &val)
 Sets the angle covered by the spotlights inner cone. More...
 
void setSpotlightNearClipDistance (Real nearClip)
 Set the near clip plane distance to be used by spotlights that use light clipping, allowing you to render spots as if they start from further down their frustum. More...
 
void setSpotlightOuterAngle (const Radian &val)
 Sets the angle covered by the spotlights outer cone. More...
 
void setSpotlightRange (const Radian &innerAngle, const Radian &outerAngle, Real falloff=1.0)
 Sets the range of a spotlight, i.e. More...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. More...
 
void setType (LightTypes type)
 Sets the type of light - see LightTypes for more info. More...
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
virtual void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 

Static Public Member Functions

static void buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
 SceneManager::buildLightList More...
 
static void calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
 
static void cullFrustum (const size_t numNodes, ObjectData t, const Frustum *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
 
static void cullLights (const size_t numNodes, ObjectData t, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
 SceneManager::cullLights & More...
 
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
static void updateAllBounds (const size_t numNodes, ObjectData t)
 SceneManager::updateAllBounds More...
 

Public Attributes

const FastArray< Realc_DefaultLodMesh
 
size_t mGlobalIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
size_t mParentIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
Real tempSquareDist
 Temp tag used for sorting. More...
 

Protected Types

typedef map< String,
StringVector >::type 
AnimableDictionaryMap
 
typedef map< uint16, Vector4 >
::type 
CustomParameterMap
 

Protected Member Functions

StringVector_getAnimableValueNames (void)
 Get an updateable reference to animable value list. More...
 
void _setId (IdType newId)
 In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private). More...
 
void createAnimableDictionary (void) const
 Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
 
virtual const StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. More...
 
virtual void initialiseAnimableDictionary (StringVector &) const
 Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
 
Aabb updateSingleWorldAabb ()
 
float updateSingleWorldRadius ()
 

Protected Attributes

Real mAttenuationConst
 
Real mAttenuationLinear
 
Real mAttenuationQuad
 
bool mCachedAabbOutOfDate
 
FastArray< unsigned char > mCurrentMaterialLod
 
unsigned char mCurrentMeshLod
 
CustomParameterMap mCustomParameters
 Stores the custom parameters for the light. More...
 
bool mDebugDisplay
 Is debug display enabled? More...
 
ColourValue mDiffuse
 
LightList mLightList
 List of lights for this object. More...
 
LightTypes mLightType
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. More...
 
FastArray< FastArray< Real >
const * > 
mLodMaterial
 
FastArray< Real > const * mLodMesh
 
SceneManagermManager
 SceneManager holding this object (if applicable) More...
 
Real mMinPixelSize
 Minimum pixel size to still render. More...
 
String mName
 Friendly name of this object, can be empty. More...
 
ObjectData mObjectData
 All the object data needed in SoA form. More...
 
ObjectMemoryManagermObjectMemoryManager
 The memory manager used to allocate the ObjectData. More...
 
bool mOwnShadowFarDist
 
NodemParentNode
 Node to which this object is attached. More...
 
Real mPowerScale
 
Real mRange
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
Real mShadowFarClipDist
 
Real mShadowFarDist
 
Real mShadowFarDistSquared
 
Real mShadowNearClipDist
 
ColourValue mSpecular
 
Real mSpotFalloff
 
Radian mSpotInner
 
Real mSpotNearClip
 
Radian mSpotOuter
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 

Static Protected Attributes

static AnimableDictionaryMap msAnimableDictionary
 Static map of class name to list of animable value names. More...
 
static uint32 msDefaultQueryFlags
 Default query flags. More...
 
static uint32 msDefaultVisibilityFlags
 Default visibility flags. More...
 
static String msMovableType
 Shared class-level name for Movable type. More...
 

Detailed Description

Representation of a dynamic light source in the scene.

Remarks
Lights are added to the scene like any other object. They contain various parameters like type, position, attenuation (how light intensity fades with distance), colour etc.
The defaults when a light is created is pure white diffuse light, with no attenuation (does not decrease with distance) and a range of 1000 world units.
Lights are created by using the SceneManager::createLight method. Starting Ogre 2.0 all Lights must be associated to a SceneNode in order to work; which holds the position and direction. Light::setDirection and Light::getDirection will redirect to the SceneNode and assert or crash if not attached to one.
Remember also that dynamic lights rely on modifying the colour of vertices based on the position of the light compared to an object's vertex normals. Dynamic lighting will only look good if the object being lit has a fair level of tessellation and the normals are properly set. This is particularly true for the spotlight which will only look right on highly tessellated models. In the future OGRE may be extended for certain scene types so an alternative to the standard dynamic lighting may be used, such as dynamic lightmaps.

Definition at line 70 of file OgreLight.h.

Member Typedef Documentation

Definition at line 237 of file OgreAnimable.h.

Definition at line 504 of file OgreLight.h.

SceneManager::cullFrustum

Remarks
We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time
Parameters
frustumFrustum to clip against
sceneVisibilityFlagsCombined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjectsOut. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCameraCamera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

Definition at line 244 of file OgreMovableObject.h.

Member Enumeration Documentation

Defines the type of light.

Enumerator
LT_POINT 

Point light sources give off light equally in all directions, so require only position not direction.

LT_DIRECTIONAL 

Directional lights simulate parallel light beams from a distant source, hence have direction but no position.

LT_SPOTLIGHT 

Spotlights simulate a cone of light from a source so require position and direction, plus extra values for falloff.

Definition at line 79 of file OgreLight.h.

Constructor & Destructor Documentation

Ogre::Light::Light ( IdType  id,
ObjectMemoryManager objectMemoryManager 
)

Normal constructor.

Should not be called directly, but rather the SceneManager::createLight method should be used.

Ogre::Light::~Light ( )

Standard destructor.

Member Function Documentation

void Ogre::Light::_calcTempSquareDist ( const Vector3 worldPos)

Internal method for calculating current squared distance from some world position.

Real Ogre::Light::_deriveShadowFarClipDistance ( const Camera maincam) const

Derive a shadow camera far distance from either the light, or from the main camera if the light doesn't have its own setting.

Real Ogre::Light::_deriveShadowNearClipDistance ( const Camera maincam) const

Derive a shadow camera near distance from either the light, or from the main camera if the light doesn't have its own setting.

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void  )
inlineprotectedinherited

Get an updateable reference to animable value list.

Definition at line 263 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

LightList* Ogre::MovableObject::_getLightList ( )
inlineinherited

Returns a pointer to the current list of lights for this object.

Remarks
You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 534 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::_getManager ( void  ) const
inlineinherited

Get the manager of this object, if any (internal use only)

Definition at line 160 of file OgreMovableObject.h.

ObjectData& Ogre::MovableObject::_getObjectData ( )
inlineinherited

Returns a direct access to the ObjectData state.

Definition at line 387 of file OgreMovableObject.h.

const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void  ) const
inherited

Returns the full transformation of the parent sceneNode or the attachingPoint node.

virtual void Ogre::MovableObject::_notifyAttached ( Node parent)
virtualinherited

Internal method called to notify the object that it has been attached to a node.

Reimplemented in Ogre::Entity, Ogre::ParticleSystem, and Ogre::InstancedEntity.

Referenced by Ogre::PortalBase::_notifyAttached().

void Ogre::MovableObject::_notifyManager ( SceneManager man)
inlineinherited

Notify the object of it's manager (internal use only)

Definition at line 158 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyParentNodeMemoryChanged ( void  )
inlinevirtualinherited

Node::_callMemoryChangeListeners

Reimplemented in Ogre::InstancedEntity.

Definition at line 187 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyStaticDirty ( void  ) const
inlinevirtualinherited

Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

See also
SceneManager::notifyStaticDirty

Reimplemented in Ogre::InstancedEntity.

Definition at line 212 of file OgreMovableObject.h.

void Ogre::MovableObject::_setCachedAabbOutOfDate ( void  )
inlineinherited

Definition at line 586 of file OgreMovableObject.h.

void Ogre::IdObject::_setId ( IdType  newId)
inlineprotectedinherited

In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private).

Definition at line 63 of file OgreId.h.

virtual void Ogre::Light::_updateCustomGpuParameter ( uint16  paramIndex,
const GpuProgramParameters::AutoConstantEntry constantEntry,
GpuProgramParameters params 
) const
virtual

Update a custom GpuProgramParameters constant which is derived from information only this Light knows.

Remarks
This method allows a Light to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_LIGHT_CUSTOM, and to allow there to be more than one of these per Light, the 'data' field on the auto parameter will identify which parameter is being updated and on which light. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object.
You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.
Parameters
paramIndexThe index of the constant being updated
constantEntryThe auto constant entry from the program parameters
paramsThe parameters object which this method should call to set the updated parameters.
virtual void Ogre::Light::_updateRenderQueue ( RenderQueue queue,
Camera camera,
const Camera lodCamera 
)
inlinevirtual

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks
The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implements Ogre::MovableObject.

Definition at line 306 of file OgreLight.h.

void Ogre::MovableObject::addQueryFlags ( uint32  flags)
inlineinherited

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

void Ogre::MovableObject::addVisibilityFlags ( uint32  flags)
inlineinherited

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

static void Ogre::MovableObject::buildLightList ( const size_t  numNodes,
ObjectData  t,
const LightListInfo globalLightList 
)
staticinherited

SceneManager::buildLightList

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Parameters
globalLightListList of lights already culled against all possible frustums and reorganized contiguously for SoA
static void Ogre::MovableObject::calculateCastersBox ( const size_t  numNodes,
ObjectData  t,
uint32  sceneVisibilityFlags,
AxisAlignedBox outBox 
)
staticinherited
void Ogre::AnimableObject::createAnimableDictionary ( void  ) const
inlineprotectedinherited

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 250 of file OgreAnimable.h.

AnimableValuePtr Ogre::Light::createAnimableValue ( const String valueName)
virtual

Create a reference-counted AnimableValuePtr for the named value.

Remarks
You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented from Ogre::AnimableObject.

static void Ogre::MovableObject::cullFrustum ( const size_t  numNodes,
ObjectData  t,
const Frustum frustum,
uint32  sceneVisibilityFlags,
MovableObjectArray outCulledObjects,
const Camera lodCamera 
)
staticinherited
static void Ogre::MovableObject::cullLights ( const size_t  numNodes,
ObjectData  t,
LightListInfo outGlobalLightList,
const FrustumVec frustums,
const FrustumVec cubemapFrustums 
)
staticinherited

SceneManager::cullLights &

See also
MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList
Remarks
We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.
Parameters
outGlobalLightListOutput, a list of lights, contiguously placed
frustumsAn array of all frustums we need to check against
cubemapFrustumsAn array of all frustums that are used at least once as cubemaps ( SceneManager::createCamera)
void Ogre::MovableObject::detachFromParent ( void  )
inherited

Detaches an object from a parent SceneNode if attached.

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void  ) const
inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

Remarks
Subclasses must override this if they want to support animation of their values.

Definition at line 245 of file OgreAnimable.h.

References Ogre::BLANKSTRING.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void  ) const
inlineinherited

Gets a list of animable value names for this object.

Definition at line 291 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

Vector4 Ogre::Light::getAs4DVector ( void  ) const

Remarks
Although lights themselves are not 'visible', setting a light to invisible means it no longer affects the scene. Gets the details of this light as a 4D vector.
Getting details of a light as a 4D vector can be useful for doing general calculations between different light types; for example the vector can represent both position lights (w=1.0f) and directional lights (w=0.0f) and be used in the same calculations.
Real Ogre::Light::getAttenuationConstant ( void  ) const
inline

Returns the constant factor in the attenuation formula.

Definition at line 214 of file OgreLight.h.

Real Ogre::Light::getAttenuationLinear ( void  ) const
inline

Returns the linear factor in the attenuation formula.

Definition at line 218 of file OgreLight.h.

Real Ogre::Light::getAttenuationQuadric ( void  ) const
inline

Returns the quadric factor in the attenuation formula.

Definition at line 222 of file OgreLight.h.

Real Ogre::Light::getAttenuationRange ( void  ) const
inline

Returns the absolute upper range of the light.

Definition at line 210 of file OgreLight.h.

bool Ogre::MovableObject::getCastShadows ( void  ) const
inlineinherited

Returns whether shadow casting is enabled for this object.

const FastArray<unsigned char>& Ogre::MovableObject::getCurrentMaterialLod ( void  ) const
inlineinherited

Definition at line 536 of file OgreMovableObject.h.

const Vector4& Ogre::Light::getCustomParameter ( uint16  index) const

Gets the custom value associated with this Light at the given index.

Parameters
indexIndex of the parameter to retrieve
See also
setCustomParameter for full details.
static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )
inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 464 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )
inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 495 of file OgreMovableObject.h.

Vector3 Ogre::Light::getDerivedDirection ( void  ) const

Retrieves the direction of the light including any transform from nodes it is attached to.

Vector3 Ogre::Light::getDerivedDirectionUpdated ( void  ) const
const ColourValue& Ogre::Light::getDiffuseColour ( void  ) const
inline

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

Definition at line 132 of file OgreLight.h.

Vector3 Ogre::Light::getDirection ( void  ) const

Returns the light's direction.

Remarks
Applicable only to the spotlight and directional light types. Try to cache the value instead of calling it multiple times in the same scope
IdType Ogre::IdObject::getId ( ) const
inlineinherited

Get the unique id of this object.

Definition at line 74 of file OgreId.h.

uint32 Ogre::MovableObject::getLightMask ( ) const
inlineinherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks
By default, this mask is fully set meaning all lights will affect this object
Listener* Ogre::MovableObject::getListener ( void  ) const
inlineinherited

Gets the current listener for this object.

Definition at line 506 of file OgreMovableObject.h.

Aabb Ogre::MovableObject::getLocalAabb ( void  ) const
inherited

Retrieves the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
const String& Ogre::Light::getMovableType ( void  ) const
virtual

Returns the type name of this object.

Implements Ogre::MovableObject.

Reimplemented in Ogre::PCZLight.

const String& Ogre::MovableObject::getName ( void  ) const
inlineinherited

Returns the name of this object.

Definition at line 166 of file OgreMovableObject.h.

Node* Ogre::MovableObject::getParentNode ( void  ) const
inlineinherited

Returns the node to which this object is attached.

Definition at line 172 of file OgreMovableObject.h.

SceneNode* Ogre::MovableObject::getParentSceneNode ( void  ) const
inlineinherited
Real Ogre::Light::getPowerScale ( void  ) const
inline

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

Definition at line 303 of file OgreLight.h.

uint32 Ogre::MovableObject::getQueryFlags ( void  ) const
inlineinherited

Returns the query flags relevant for this object.

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

Real Ogre::MovableObject::getRenderingDistance ( void  ) const
inlineinherited

Gets the distance at which batches are no longer rendered.

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const
inlineinherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 338 of file OgreMovableObject.h.

uint8 Ogre::MovableObject::getRenderQueueGroup ( void  ) const
inherited

Gets the queue group for this entity, see setRenderQueueGroup for full details.

Real Ogre::Light::getShadowFarClipDistance ( ) const
inline

Get the far clip plane distance to be used by the shadow camera, if this light casts texture shadows.

Remarks
May be zero if the light doesn't have it's own far distance set; use _deriveShadowfarDistance for a version guaranteed to give a result.

Definition at line 404 of file OgreLight.h.

Real Ogre::Light::getShadowFarDistance ( void  ) const

Gets the maximum distance away from the camera that shadows by this light will be visible.

Real Ogre::Light::getShadowFarDistanceSquared ( void  ) const
Real Ogre::Light::getShadowNearClipDistance ( ) const
inline

Get the near clip plane distance to be used by the shadow camera, if this light casts texture shadows.

Remarks
May be zero if the light doesn't have it's own near distance set; use _deriveShadowNearDistance for a version guaranteed to give a result.

Definition at line 380 of file OgreLight.h.

const ColourValue& Ogre::Light::getSpecularColour ( void  ) const
inline

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

Definition at line 158 of file OgreLight.h.

Real Ogre::Light::getSpotlightFalloff ( void  ) const
inline

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

Definition at line 263 of file OgreLight.h.

const Radian& Ogre::Light::getSpotlightInnerAngle ( void  ) const
inline

Returns the angle covered by the spotlights inner cone.

Definition at line 255 of file OgreLight.h.

Real Ogre::Light::getSpotlightNearClipDistance ( ) const
inline

Get the near clip plane distance to be used by spotlights that use light clipping.

Definition at line 288 of file OgreLight.h.

const Radian& Ogre::Light::getSpotlightOuterAngle ( void  ) const
inline

Returns the angle covered by the spotlights outer cone.

Definition at line 259 of file OgreLight.h.

LightTypes Ogre::Light::getType ( void  ) const
inline

Returns the light type.

Definition at line 103 of file OgreLight.h.

uint32 Ogre::Light::getTypeFlags ( void  ) const

Override to return specific type flag.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 344 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 350 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::getVisibilityFlags ( void  ) const
inlineinherited

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

bool Ogre::MovableObject::getVisible ( void  ) const
inlineinherited

Gets this object whether to be visible or not, if it has a renderable component.

Remarks
Returns the value set by MovableObject::setVisible only.
Aabb Ogre::MovableObject::getWorldAabb ( ) const
inherited

Gets the axis aligned box in world space.

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldAabbUpdated if you need the update process to be guaranteed
Aabb Ogre::MovableObject::getWorldAabbUpdated ( )
inherited

Gets the axis aligned box in world space.

Remarks
Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
float Ogre::MovableObject::getWorldRadius ( ) const
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldRadiusUpdated if you need the update process to be guaranteed
float Ogre::MovableObject::getWorldRadiusUpdated ( )
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Definition at line 283 of file OgreAnimable.h.

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded ( const Frustum frustum,
const Camera lodCamera,
uint32  combinedVisibilityFlags 
)
inlinevirtualinherited

InstancingTheadedCullingMethod,

See also
InstanceBatch::instanceBatchCullFrustumThreaded

Reimplemented in Ogre::InstanceBatchHW_VTF, and Ogre::InstanceBatchHW.

Definition at line 250 of file OgreMovableObject.h.

bool Ogre::MovableObject::isAttached ( void  ) const
inlineinherited

Returns true if this object is attached to a Node.

Definition at line 181 of file OgreMovableObject.h.

bool Ogre::MovableObject::isCachedAabbOutOfDate ( ) const
inlineinherited

Definition at line 587 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void  ) const
inlinevirtualinherited

Gets whether debug display of this object is enabled.

Definition at line 582 of file OgreMovableObject.h.

bool Ogre::Light::isInLightRange ( const Ogre::Sphere sphere) const

Check whether a sphere is included in the lighted area of the light.

Note
The function trades accuracy for efficiency. As a result you may get false-positives (The function should not return any false-negatives).
bool Ogre::Light::isInLightRange ( const Ogre::AxisAlignedBox container) const

Check whether a bounding box is included in the lighted area of the light.

Note
The function trades accuracy for efficiency. As a result you may get false-positives (The function should not return any false-negatives).
bool Ogre::MovableObject::isStatic ( ) const
inherited

Checks whether this MovableObject is static. setStatic.

bool Ogre::MovableObject::isVisible ( void  ) const
inherited

Returns whether or not this object is supposed to be visible or not.

Remarks
Takes into account visibility flags and the setVisible, but not rendering distance.
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 76 of file OgreId.h.

References Ogre::IdObject::mId.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 81 of file OgreId.h.

References Ogre::IdObject::mId.

const LightList& Ogre::MovableObject::queryLights ( void  ) const
inlineinherited

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks
The lights are filled in
See also
buildLightList
Returns
The list of lights use to lighting this object.

Definition at line 513 of file OgreMovableObject.h.

void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlineinherited

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags)
inlineinherited

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

void Ogre::Light::resetShadowFarDistance ( void  )

Tells the light to use the shadow far distance of the SceneManager.

void Ogre::Light::setAttenuation ( Real  range,
Real  constant,
Real  linear,
Real  quadratic 
)

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

how it diminishes with distance.

Remarks
Lights normally get fainter the further they are away. Also, each light is given a maximum range beyond which it cannot affect any objects.
Light attenuation is not applicable to directional lights since they have an infinite range and constant intensity.
This follows a standard attenuation approach - see any good 3D text for the details of what they mean since i don't have room here!
Parameters
rangeThe absolute upper range of the light in world units.
constantThe constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation.
linearThe linear factor in the attenuation formula: 1 means attenuate evenly over the distance.
quadraticThe quadratic factor in the attenuation formula: adds a curvature to the attenuation formula.
void Ogre::Light::setAttenuationBasedOnRadius ( Real  radius,
Real  lumThreshold 
)

Sets the attenuation parameters (range, constant, linear & quadratic,.

See also
setAttenuation) based on a given radius.
Remarks
The actual attenuation formula is:

1

( (distance / radius) + 1 )² Which can be derived as:

1

1 + 2/r * d + 1 / r² * d²

The original formula never ends, that is the range is infinity. This function calculates a range based on "lumThreshold": When the luminosity past certain distance is below the established threshold, the light calculations are cut.

Parameters
radiusThe radius of the light. i.e. A light bulb is a couple centimeters, the sun is ~696km Note: Having a radius = 2 doesn't mean that at distance = 2 the pixel is lit 100% (at r = d; the pixel is lit by 25%)
lumThresholdValue in the range [0; 1) Sets range at which the luminance (in percentage) of a point would go below the threshold. For example lumThreshold = 0 means the attenuation range is infinity; lumThreshold = 1 means the range is set to 0.
void Ogre::MovableObject::setCastShadows ( bool  enabled)
inlineinherited

Sets whether or not this object will cast shadows.

Remarks
This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.
Note
This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.
void Ogre::Light::setCustomParameter ( uint16  index,
const Vector4 value 
)

Sets a custom parameter for this Light, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks
Calling this method simply associates a numeric index with a 4-dimensional value for this specific Light. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_LIGHT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.
Parameters
indexThe index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_LIGHT_CUSTOM entry, if that is used.
valueThe value to associate.
virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool  enabled)
inlinevirtualinherited

Sets whether or not the debug display of this object is enabled.

Remarks
Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 580 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32  flags)
inlinestaticinherited

Set the default query flags for all future MovableObject instances.

Definition at line 460 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32  flags)
inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

void Ogre::Light::setDiffuseColour ( Real  red,
Real  green,
Real  blue 
)
inline

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

Remarks
Material objects have ambient, diffuse and specular values which indicate how much of each type of light an object reflects. This value denotes the amount and colour of this type of light the light exudes into the scene. The actual appearance of objects is a combination of the two.
Diffuse light simulates the typical light emanating from light sources and affects the base colour of objects together with ambient light.
void Ogre::Light::setDiffuseColour ( const ColourValue colour)
inline

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

Remarks
Material objects have ambient, diffuse and specular values which indicate how much of each type of light an object reflects. This value denotes the amount and colour of this type of light the light exudes into the scene. The actual appearance of objects is a combination of the two.
Diffuse light simulates the typical light emanating from light sources and affects the base colour of objects together with ambient light.
void Ogre::Light::setDirection ( const Vector3 vec)

Sets the direction in which a light points.

Remarks
Applicable only to the spotlight and directional light types.
Note
This direction will be concatenated with the parent SceneNode.
void Ogre::MovableObject::setLightMask ( uint32  lightMask)
inlineinherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks
This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object
void Ogre::MovableObject::setListener ( Listener listener)
inlineinherited

Sets a listener for this object.

Remarks
Note for size and performance reasons only one listener per object is allowed.

Definition at line 502 of file OgreMovableObject.h.

void Ogre::MovableObject::setLocalAabb ( const Aabb  box)
inherited

Sets the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
void Ogre::MovableObject::setName ( const String name)
inlineinherited

Sets a custom name for this node.

Doesn't have to be unique

Definition at line 163 of file OgreMovableObject.h.

void Ogre::Light::setPowerScale ( Real  power)

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

Remarks
This factor is only useful in High Dynamic Range (HDR) rendering. You can bind it to a shader variable to take it into account,
See also
GpuProgramParameters
Parameters
powerThe power rating of this light, default is 1.0.
void Ogre::MovableObject::setQueryFlags ( uint32  flags)
inlineinherited

Sets the query flags for this object.

Remarks
When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.
void Ogre::MovableObject::setRenderingDistance ( Real  dist)
inlineinherited

Sets the distance at which the object is no longer rendered.

Parameters
distDistance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.
void Ogre::MovableObject::setRenderingMinPixelSize ( Real  pixelSize)
inlineinherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note
Camera::setUseMinPixelSize() needs to be called for this parameter to be used.
Parameters
pixelSizeNumber of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 331 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8  queueID)
virtualinherited

Sets the render queue group this entity will be rendered through.

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority ( uint8  queueID,
ushort  priority 
)
virtualinherited

Sets the render queue group and group priority this entity will be rendered through.

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

void Ogre::Light::setShadowFarClipDistance ( Real  farClip)
inline

Set the far clip plane distance to be used by the shadow camera, if this light casts texture shadows.

Remarks
This is different from the 'shadow far distance', which is always measured from the main camera. This distance is the far clip plane of the light camera.
Parameters
farClipThe distance, or -1 to use the main camera setting.

Definition at line 396 of file OgreLight.h.

void Ogre::Light::setShadowFarDistance ( Real  distance)

Sets the maximum distance away from the camera that shadows by this light will be visible.

Remarks
Shadow techniques can be expensive, therefore it is a good idea to limit them to being rendered close to the camera if possible, and to skip the expense of rendering shadows for distance objects. This method allows you to set the distance at which shadows will no longer be rendered.
Note
Each shadow technique can interpret this subtely differently. For example, one technique may use this to eliminate casters, another might use it to attenuate the shadows themselves. You should tweak this value to suit your chosen shadow technique and scene setup.
void Ogre::Light::setShadowNearClipDistance ( Real  nearClip)
inline

Set the near clip plane distance to be used by the shadow camera, if this light casts texture shadows.

Parameters
nearClipThe distance, or -1 to use the main camera setting.

Definition at line 372 of file OgreLight.h.

void Ogre::Light::setSpecularColour ( Real  red,
Real  green,
Real  blue 
)
inline

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

Remarks
Material objects have ambient, diffuse and specular values which indicate how much of each type of light an object reflects. This value denotes the amount and colour of this type of light the light exudes into the scene. The actual appearance of objects is a combination of the two.
Specular light affects the appearance of shiny highlights on objects, and is also dependent on the 'shininess' Material value.
void Ogre::Light::setSpecularColour ( const ColourValue colour)
inline

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

Remarks
Material objects have ambient, diffuse and specular values which indicate how much of each type of light an object reflects. This value denotes the amount and colour of this type of light the light exudes into the scene. The actual appearance of objects is a combination of the two.
Specular light affects the appearance of shiny highlights on objects, and is also dependent on the 'shininess' Material value.
void Ogre::Light::setSpotAabb ( void  )

Sets the Aabb (local space) for this light when it's of type spot.

void Ogre::Light::setSpotlightFalloff ( Real  val)
inline

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

void Ogre::Light::setSpotlightInnerAngle ( const Radian val)

Sets the angle covered by the spotlights inner cone.

void Ogre::Light::setSpotlightNearClipDistance ( Real  nearClip)
inline

Set the near clip plane distance to be used by spotlights that use light clipping, allowing you to render spots as if they start from further down their frustum.

Parameters
nearClipThe near distance.

Definition at line 283 of file OgreLight.h.

void Ogre::Light::setSpotlightOuterAngle ( const Radian val)

Sets the angle covered by the spotlights outer cone.

void Ogre::Light::setSpotlightRange ( const Radian innerAngle,
const Radian outerAngle,
Real  falloff = 1.0 
)

Sets the range of a spotlight, i.e.

the angle of the inner and outer cones and the rate of falloff between them.

Parameters
innerAngleAngle covered by the bright inner cone
Note
The inner cone applicable only to Direct3D, it'll always treat as zero in OpenGL.
Parameters
outerAngleAngle covered by the outer cone
falloffThe rate of falloff between the inner and outer cones. 1.0 means a linear falloff, less means slower falloff, higher means faster falloff.
bool Ogre::MovableObject::setStatic ( bool  bStatic)
inherited

Turns this Node into static or dynamic.

Remarks
Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times
Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)
Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. Node::setStatic
Returns
True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported
void Ogre::Light::setType ( LightTypes  type)

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

void Ogre::MovableObject::setVisibilityFlags ( uint32  flags)
inlineinherited

Sets the visibility flags for this object.

Remarks
As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).
void Ogre::MovableObject::setVisible ( bool  visible)
inlineinherited

Tells this object whether to be visible or not, if it has a renderable component.

Note
An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.
static void Ogre::MovableObject::updateAllBounds ( const size_t  numNodes,
ObjectData  t 
)
staticinherited

SceneManager::updateAllBounds

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Aabb Ogre::MovableObject::updateSingleWorldAabb ( )
protectedinherited
float Ogre::MovableObject::updateSingleWorldRadius ( )
protectedinherited
virtual void Ogre::Light::visitRenderables ( Renderable::Visitor visitor,
bool  debugRenderables = false 
)
inlinevirtual

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters
visitorPointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderablesIf false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

Definition at line 339 of file OgreLight.h.

Member Data Documentation

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh
inherited

Definition at line 65 of file OgreMovableObject.h.

Real Ogre::Light::mAttenuationConst
protected

Definition at line 490 of file OgreLight.h.

Real Ogre::Light::mAttenuationLinear
protected

Definition at line 491 of file OgreLight.h.

Real Ogre::Light::mAttenuationQuad
protected

Definition at line 492 of file OgreLight.h.

bool Ogre::MovableObject::mCachedAabbOutOfDate
mutableprotectedinherited

Definition at line 117 of file OgreMovableObject.h.

FastArray<unsigned char> Ogre::MovableObject::mCurrentMaterialLod
protectedinherited

Definition at line 97 of file OgreMovableObject.h.

unsigned char Ogre::MovableObject::mCurrentMeshLod
protectedinherited

Definition at line 96 of file OgreMovableObject.h.

CustomParameterMap Ogre::Light::mCustomParameters
protected

Stores the custom parameters for the light.

Definition at line 506 of file OgreLight.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 111 of file OgreMovableObject.h.

ColourValue Ogre::Light::mDiffuse
protected

Definition at line 482 of file OgreLight.h.

size_t Ogre::MovableObject::mGlobalIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 140 of file OgreMovableObject.h.

LightList Ogre::MovableObject::mLightList
protectedinherited

List of lights for this object.

Definition at line 108 of file OgreMovableObject.h.

LightTypes Ogre::Light::mLightType
protected

Definition at line 481 of file OgreLight.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

MovableObject listener - only one allowed (no list) for size & performance reasons.

Definition at line 105 of file OgreMovableObject.h.

FastArray< FastArray<Real> const * > Ogre::MovableObject::mLodMaterial
protectedinherited

Definition at line 95 of file OgreMovableObject.h.

FastArray<Real> const* Ogre::MovableObject::mLodMesh
protectedinherited

Definition at line 94 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 91 of file OgreMovableObject.h.

Real Ogre::MovableObject::mMinPixelSize
protectedinherited

Minimum pixel size to still render.

Definition at line 100 of file OgreMovableObject.h.

String Ogre::MovableObject::mName
protectedinherited

Friendly name of this object, can be empty.

Definition at line 121 of file OgreMovableObject.h.

ObjectData Ogre::MovableObject::mObjectData
protectedinherited

All the object data needed in SoA form.

Definition at line 89 of file OgreMovableObject.h.

ObjectMemoryManager* Ogre::MovableObject::mObjectMemoryManager
protectedinherited

The memory manager used to allocate the ObjectData.

Definition at line 114 of file OgreMovableObject.h.

bool Ogre::Light::mOwnShadowFarDist
protected

Definition at line 494 of file OgreLight.h.

size_t Ogre::MovableObject::mParentIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 142 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

Node to which this object is attached.

Definition at line 83 of file OgreMovableObject.h.

Real Ogre::Light::mPowerScale
protected

Definition at line 493 of file OgreLight.h.

Real Ogre::Light::mRange
protected

Definition at line 489 of file OgreLight.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 85 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 87 of file OgreMovableObject.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

Static map of class name to list of animable value names.

Definition at line 239 of file OgreAnimable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 125 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 127 of file OgreMovableObject.h.

Real Ogre::Light::mShadowFarClipDist
protected

Definition at line 499 of file OgreLight.h.

Real Ogre::Light::mShadowFarDist
protected

Definition at line 495 of file OgreLight.h.

Real Ogre::Light::mShadowFarDistSquared
protected

Definition at line 496 of file OgreLight.h.

Real Ogre::Light::mShadowNearClipDist
protected

Definition at line 498 of file OgreLight.h.

String Ogre::Light::msMovableType
staticprotected

Shared class-level name for Movable type.

Definition at line 502 of file OgreLight.h.

ColourValue Ogre::Light::mSpecular
protected

Definition at line 483 of file OgreLight.h.

Real Ogre::Light::mSpotFalloff
protected

Definition at line 487 of file OgreLight.h.

Radian Ogre::Light::mSpotInner
protected

Definition at line 486 of file OgreLight.h.

Real Ogre::Light::mSpotNearClip
protected

Definition at line 488 of file OgreLight.h.

Radian Ogre::Light::mSpotOuter
protected

Definition at line 485 of file OgreLight.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 102 of file OgreMovableObject.h.

Real Ogre::Light::tempSquareDist

Temp tag used for sorting.

Definition at line 74 of file OgreLight.h.


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