Ogre::RenderQueueInvocation Class Reference
[RenderSystem]

Class representing the invocation of queue groups in a RenderQueue. More...

#include <OgreRenderQueueInvocation.h>

Inheritance diagram for Ogre::RenderQueueInvocation:

Public Member Functions
	RenderQueueInvocation (uint8 renderQueueGroupID, const String &invocationName=StringUtil::BLANK)
	Constructor.
virtual	~RenderQueueInvocation ()
virtual uint8	getRenderQueueGroupID (void) const
	Get the render queue group id.
virtual const String &	getInvocationName (void) const
	Get the invocation name (may be blank if not set by creator).
virtual void	setSolidsOrganisation (QueuedRenderableCollection::OrganisationMode org)
	Set the organisation mode being used for solids in this queue group invocation.
virtual QueuedRenderableCollection::OrganisationMode	getSolidsOrganisation (void) const
	Get the organisation mode being used for solids in this queue group invocation.
virtual void	setSuppressShadows (bool suppress)
	Sets whether shadows are suppressed when invoking this queue.
virtual bool	getSuppressShadows (void) const
	Gets whether shadows are suppressed when invoking this queue.
virtual void	setSuppressRenderStateChanges (bool suppress)
	Sets whether render state changes are suppressed when invoking this queue.
virtual bool	getSuppressRenderStateChanges (void) const
	Gets whether shadows are suppressed when invoking this queue.
virtual void	invoke (RenderQueueGroup group, SceneManager targetSceneManager)
	Invoke this class on a concrete queue group.
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)
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 *)
Static Public Attributes
static String	RENDER_QUEUE_INVOCATION_SHADOWS
	Invocation identifier for shadows.
Protected Attributes
uint8	mRenderQueueGroupID
	Target queue group.
String	mInvocationName
	Invocation identifier - used in listeners.
QueuedRenderableCollection::OrganisationMode	mSolidsOrganisation
	Solids ordering mode.
bool	mSuppressShadows
	Suppress shadows processing in this invocation?
bool	mSuppressRenderStateChanges
	Suppress OGRE's render state management?

Detailed Description

Class representing the invocation of queue groups in a RenderQueue.

Remarks:: The default behaviour for OGRE's render queue is to render each queue group in turn, dealing with shadows automatically, and rendering solids in grouped passes, followed by transparent objects in descending order. This class, together with RenderQueueInvocationSequence and the ability to associate one with a Viewport, allows you to change that behaviour and render queue groups in arbitrary sequence, repeatedly, and to skip shadows, change the ordering of solids, or even prevent OGRE controlling the render state during a particular invocation for special effects.

: Note that whilst you can change the ordering of rendering solids, you can't change the ordering on transparent objects, since to do this would cause them to render incorrectly.

: As well as using this class directly and using the options it provides you with, you can also provide subclasses of it to a RenderQueueInvocationSequence instance if you want to gain ultimate control.

Note:: Invocations will be skipped if there are scene-level options preventing them being rendered - for example special-case render queues and render queue listeners that dictate this.

Definition at line 66 of file OgreRenderQueueInvocation.h.

Constructor & Destructor Documentation

Ogre::RenderQueueInvocation::RenderQueueInvocation	(	uint8	renderQueueGroupID,
		const String &	invocationName = `StringUtil::BLANK`
	)

Constructor.

Parameters:

	renderQueueGroupID	ID of the queue this will target
	invocationName	Optional name to uniquely identify this invocation from others in a RenderQueueListener

virtual Ogre::RenderQueueInvocation::~RenderQueueInvocation ( ) [virtual]

Member Function Documentation

virtual const String& Ogre::RenderQueueInvocation::getInvocationName ( void ) const [virtual]

Get the invocation name (may be blank if not set by creator).

Definition at line 93 of file OgreRenderQueueInvocation.h.

virtual uint8 Ogre::RenderQueueInvocation::getRenderQueueGroupID ( void ) const [virtual]

Get the render queue group id.

Definition at line 90 of file OgreRenderQueueInvocation.h.

virtual QueuedRenderableCollection::OrganisationMode Ogre::RenderQueueInvocation::getSolidsOrganisation ( void ) const [virtual]

Get the organisation mode being used for solids in this queue group invocation.

Definition at line 106 of file OgreRenderQueueInvocation.h.

virtual bool Ogre::RenderQueueInvocation::getSuppressRenderStateChanges ( void ) const [virtual]

Gets whether shadows are suppressed when invoking this queue.

Definition at line 145 of file OgreRenderQueueInvocation.h.

virtual bool Ogre::RenderQueueInvocation::getSuppressShadows ( void ) const [virtual]

Gets whether shadows are suppressed when invoking this queue.

Definition at line 118 of file OgreRenderQueueInvocation.h.

virtual void Ogre::RenderQueueInvocation::invoke	(	RenderQueueGroup *	group,
		SceneManager *	targetSceneManager
	)			`[virtual]`

Invoke this class on a concrete queue group.

Remarks:: Implementation will send the queue group to the target scene manager after doing what it needs to do.

template<class Alloc >

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 112 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 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 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 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 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 85 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::RenderQueueInvocation::setSolidsOrganisation ( QueuedRenderableCollection::OrganisationMode org ) [virtual]

Set the organisation mode being used for solids in this queue group invocation.

Definition at line 98 of file OgreRenderQueueInvocation.h.

virtual void Ogre::RenderQueueInvocation::setSuppressRenderStateChanges ( bool suppress ) [virtual]

Sets whether render state changes are suppressed when invoking this queue.

Remarks:: When doing special effects you may want to set up render state yourself and have it apply for the entire rendering of a queue. In that case, you should call this method with a parameter of 'true', and use a RenderQueueListener to set the render state directly on RenderSystem yourself before the invocation.

: Suppressing render state changes is only intended for advanced use, don't use it if you're unsure of the effect. The only RenderSystem calls made are to set the world matrix for each object (note - view an projection matrices are NOT SET - they are under your control) and to render the object; it is up to the caller to do everything else, including enabling any vertex / fragment programs and updating their parameter state, and binding parameters to the RenderSystem. We advise you use a RenderQueueListener in order to get a notification when this invocation is going to happen (use an invocation name to identify it if you like), at which point you can set the state you need to apply before the objects are rendered.

Definition at line 140 of file OgreRenderQueueInvocation.h.

virtual void Ogre::RenderQueueInvocation::setSuppressShadows ( bool suppress ) [virtual]

Sets whether shadows are suppressed when invoking this queue.