Ogre::HlmsManager Class Reference

#include <OgreHlmsManager.h>

Inheritance diagram for Ogre::HlmsManager:

Public Member Functions
	HlmsManager (SceneManager *sceneManager, const String &pieseFilesResorceGroup=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
virtual	~HlmsManager ()
void	bind (Renderable *rend, HlmsMaterialBase *material, const String &passName)
bool	hasBinding (Renderable *rend, const String &passName)
virtual void	notifyRenderSingleObject (Renderable *rend, const Pass *pass, const AutoParamDataSource *source, const LightList *pLightList, bool suppressRenderStateChanges)
	Event raised when render single object started.
virtual void	postFindVisibleObjects (SceneManager *source, IlluminationRenderStage irs, Viewport *v)
	Called after searching for visible objects in this SceneManager.
virtual void	postUpdateSceneGraph (SceneManager *source, Camera *camera)
	Called after updating the scene graph in this SceneManager.
virtual void	preFindVisibleObjects (SceneManager *source, SceneManager::IlluminationRenderStage irs, Viewport *v)
	Called prior to searching for visible objects in this SceneManager.
virtual void	preUpdateSceneGraph (SceneManager *source, Camera *camera)
	Called prior to updating the scene graph in this SceneManager.
virtual void	sceneManagerDestroyed (SceneManager *source)
	Event notifying the listener of the SceneManager's destruction.
virtual void	shadowTextureCasterPreViewProj (Light *light, Camera *camera, size_t iteration)
	This event occurs just before the view & projection matrices are set for rendering into a shadow texture.
virtual void	shadowTextureReceiverPreViewProj (Light *light, Frustum *frustum)
	This event occurs just before the view & projection matrices are set for re-rendering a shadow receiver.
virtual void	shadowTexturesUpdated (size_t numberOfShadowTextures)
	Event raised after all shadow textures have been rendered into for all queues / targets but before any other geometry has been rendered (including main scene geometry and any additional shadow receiver passes).
virtual bool	sortLightsAffectingFrustum (LightList &lightList)
	Hook to allow the listener to override the ordering of lights for the entire frustum.
void	unbind (Renderable *rend, const String &passName)
void	unbindAll (const String &passName)

Member Function Documentation

preUpdateSceneGraph()

virtual void Ogre::SceneManager::Listener::preUpdateSceneGraph ( SceneManager *  source, Camera *  camera  )

inlinevirtualinherited

Called prior to updating the scene graph in this SceneManager.

Remarks

This is called before updating the scene graph for a camera.

Parameters

source	The SceneManager instance raising this event.
camera	The camera being updated.

postUpdateSceneGraph()

virtual void Ogre::SceneManager::Listener::postUpdateSceneGraph ( SceneManager *  source, Camera *  camera  )

inlinevirtualinherited

Called after updating the scene graph in this SceneManager.

Remarks

This is called after updating the scene graph for a camera.

Parameters

source	The SceneManager instance raising this event.
camera	The camera being updated.

postFindVisibleObjects()

virtual void Ogre::SceneManager::Listener::postFindVisibleObjects ( SceneManager *  source, IlluminationRenderStage  irs, Viewport *  v  )

inlinevirtualinherited

Called after searching for visible objects in this SceneManager.

Remarks

Note that the render queue at this stage will be full of the current scenes contents, ready for rendering. You may manually add renderables to this queue if you wish.

Parameters

source	The SceneManager instance raising this event.
irs	The stage of illumination being dealt with. IRS_NONE for a regular render, IRS_RENDER_TO_TEXTURE for a shadow caster render.
v	The viewport being updated. You can get the camera from here.

shadowTexturesUpdated()

virtual void Ogre::SceneManager::Listener::shadowTexturesUpdated ( size_t  numberOfShadowTextures )

inlinevirtualinherited

Event raised after all shadow textures have been rendered into for all queues / targets but before any other geometry has been rendered (including main scene geometry and any additional shadow receiver passes).

Remarks

This callback is useful for those that wish to perform some additional processing on shadow textures before they are used to render shadows. For example you could perform some filtering by rendering the existing shadow textures into another alternative shadow texture with a shader.]

Note

This event will only be fired when texture shadows are in use.

Parameters

numberOfShadowTextures

The number of shadow textures in use

shadowTextureCasterPreViewProj()

virtual void Ogre::SceneManager::Listener::shadowTextureCasterPreViewProj ( Light *  light, Camera *  camera, size_t  iteration  )

inlinevirtualinherited

This event occurs just before the view & projection matrices are set for rendering into a shadow texture.

Remarks

You can use this event hook to perform some custom processing, such as altering the camera being used for rendering the light's view, including setting custom view & projection matrices if you want to perform an advanced shadow technique.

Note

This event will only be fired when texture shadows are in use.

Parameters

light	Pointer to the light for which shadows are being rendered
camera	Pointer to the camera being used to render
iteration	For lights that use multiple shadow textures, the iteration number

shadowTextureReceiverPreViewProj()

virtual void Ogre::SceneManager::Listener::shadowTextureReceiverPreViewProj ( Light *  light, Frustum *  frustum  )

inlinevirtualinherited

This event occurs just before the view & projection matrices are set for re-rendering a shadow receiver.

Remarks

You can use this event hook to perform some custom processing, such as altering the projection frustum being used for rendering the shadow onto the receiver to perform an advanced shadow technique.

Note

This event will only be fired when texture shadows are in use.

Parameters

light	Pointer to the light for which shadows are being rendered
frustum	Pointer to the projection frustum being used to project the shadow texture

sortLightsAffectingFrustum()

virtual bool Ogre::SceneManager::Listener::sortLightsAffectingFrustum ( LightList &  lightList )

inlinevirtualinherited

Hook to allow the listener to override the ordering of lights for the entire frustum.

Remarks

Whilst ordinarily lights are sorted per rendered object (

See also

MovableObject::queryLights), texture shadows adds another issue in that, given there is a finite number of shadow textures, we must choose which lights to render texture shadows from based on the entire frustum. These lights should always be listed first in every objects own list, followed by any other lights which will not cast texture shadows (either because they have shadow casting off, or there aren't enough shadow textures to service them).

This hook allows you to override the detailed ordering of the lights per frustum. The default ordering is shadow casters first (which you must also respect if you override this method), and ordered by distance from the camera within those 2 groups. Obviously the closest lights with shadow casting enabled will be listed first. Only lights within the range of the frustum will be in the list.

Parameters

lightList

The list of lights within range of the frustum which you may sort.

Returns

true if you sorted the list, false otherwise.

sceneManagerDestroyed()

virtual void Ogre::SceneManager::Listener::sceneManagerDestroyed ( SceneManager *  source )

inlinevirtualinherited

Event notifying the listener of the SceneManager's destruction.

Reimplemented in Ogre::Terrain.

---

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

• OgreHlmsManager.h