Ogre::OverlaySystem Class Reference

This class simplify initialization / finalization of the overlay system. More...

#include <OgreOverlaySystem.h>

Inheritance diagram for Ogre::OverlaySystem:

List of all members.

Public Member Functions
	OverlaySystem ()
virtual	~OverlaySystem ()
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
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual void	postRenderQueues ()
	Event raised after all render queues are processed.
virtual void	preRenderQueues ()
	Event raised before all render queues are processed.
virtual void	renderQueueEnded (uint8 queueGroupId, const String &invocation, bool &repeatThisInvocation)
	Event raised after a queue group is rendered.
virtual void	renderQueueStarted (uint8 queueGroupId, const String &invocation, bool &skipThisInvocation)
Private Attributes
FontManager *	mFontManager
OverlayManager *	mOverlayManager

---

Detailed Description

This class simplify initialization / finalization of the overlay system.

OGRE root did this steps before the overlay system transformed into a component.

Remarks:

Before you create a concrete instance of the OverlaySystem the OGRE::Root must be created but not initialized. In the ctor all relevant systems are created and registered. The dtor must be called before you delete OGRE::Root. To make the overlays visible (= render into your viewports) you have to register this instance as a RenderQueueListener in your scenemanager(s).

Definition at line 63 of file OgreOverlaySystem.h.

---

Member Function Documentation

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete

(

void *

ptr

)

[inherited]

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)		[inherited]

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]

(

void *

ptr

)

[inherited]

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

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
	)		[inherited]

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

)

[inherited]

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)		[inherited]

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
	)		[inherited]

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

)

[inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::RenderQueueListener::postRenderQueues

(

)

[virtual, inherited]

Event raised after all render queues are processed.

Definition at line 66 of file OgreRenderQueueListener.h.

virtual void Ogre::RenderQueueListener::preRenderQueues

(

)

[virtual, inherited]

Event raised before all render queues are processed.

Definition at line 63 of file OgreRenderQueueListener.h.

virtual void Ogre::RenderQueueListener::renderQueueEnded	(	uint8	queueGroupId,
		const String &	invocation,
		bool &	repeatThisInvocation
	)		[virtual, inherited]

Event raised after a queue group is rendered.

Remarks:

This method is called by the SceneManager after each queue group is rendered.

Parameters:

queueGroupId	The id of the queue group which has just been rendered
invocation	Name of the invocation which is causing this to be called (

See also:

RenderQueueInvocation)

Parameters:

repeatThisInvocation

A boolean passed by reference which is by default set to false. If the event sets this to true, the queue which has just been rendered will be repeated, and the renderQueueStarted and renderQueueEnded events will also be fired for it again.

Reimplemented in Ogre::CompositorChain::RQListener.

Definition at line 96 of file OgreRenderQueueListener.h.

---

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

• OgreOverlaySystem.h