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

Class to hold a linear sequence of RenderQueueInvocation objects. More...

#include <OgreRenderQueueInvocation.h>

+ Inheritance diagram for Ogre::RenderQueueInvocationSequence:
+ Collaboration diagram for Ogre::RenderQueueInvocationSequence:

Public Member Functions

 RenderQueueInvocationSequence (const String &name)
 
virtual ~RenderQueueInvocationSequence ()
 
RenderQueueInvocationadd (uint8 renderQueueGroupID, const String &invocationName)
 Add a standard invocation to the sequence. More...
 
void add (RenderQueueInvocation *i)
 Add a custom invocation to the sequence. More...
 
void clear (void)
 Clear and delete all invocations in this sequence. More...
 
RenderQueueInvocationget (size_t index)
 Gets the details of an invocation at a given index. More...
 
const StringgetName (void) const
 Get the name of this sequence. More...
 
RenderQueueInvocationIterator iterator (void)
 Get an iterator over the invocations. 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)
 
void remove (size_t index)
 Removes (and deletes) an invocation by index. More...
 
size_t size (void) const
 Get the number of invocations in this sequence. More...
 

Protected Attributes

RenderQueueInvocationList mInvocations
 
String mName
 

Detailed Description

Class to hold a linear sequence of RenderQueueInvocation objects.

Remarks
This is just a simple data holder class which contains a list of RenderQueueInvocation objects representing the sequence of invocations made for a viewport. It's only real purpose is to ensure that RenderQueueInvocation instances are deleted on shutdown, since you can provide your own subclass instances on RenderQueueInvocation. Remember that any invocation instances you give to this class will be deleted by it when it is cleared / destroyed.

Definition at line 158 of file OgreRenderQueueInvocation.h.

Constructor & Destructor Documentation

Ogre::RenderQueueInvocationSequence::RenderQueueInvocationSequence ( const String name)
virtual Ogre::RenderQueueInvocationSequence::~RenderQueueInvocationSequence ( )
virtual

Member Function Documentation

RenderQueueInvocation* Ogre::RenderQueueInvocationSequence::add ( uint8  renderQueueGroupID,
const String invocationName 
)

Add a standard invocation to the sequence.

Parameters
renderQueueGroupIDThe ID of the render queue group
invocationNameOptional name to identify the invocation, useful for listeners if a single queue group is invoked more than once
Returns
A new RenderQueueInvocatin instance which you may customise
void Ogre::RenderQueueInvocationSequence::add ( RenderQueueInvocation i)

Add a custom invocation to the sequence.

Remarks
Use this to add your own custom subclasses of RenderQueueInvocation to the sequence; just remember that this class takes ownership of deleting this pointer when it is cleared / destroyed.
void Ogre::RenderQueueInvocationSequence::clear ( void  )

Clear and delete all invocations in this sequence.

RenderQueueInvocation* Ogre::RenderQueueInvocationSequence::get ( size_t  index)

Gets the details of an invocation at a given index.

const String& Ogre::RenderQueueInvocationSequence::getName ( void  ) const
inline

Get the name of this sequence.

Definition at line 168 of file OgreRenderQueueInvocation.h.

RenderQueueInvocationIterator Ogre::RenderQueueInvocationSequence::iterator ( void  )

Get an iterator over the invocations.

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.

void Ogre::RenderQueueInvocationSequence::remove ( size_t  index)

Removes (and deletes) an invocation by index.

size_t Ogre::RenderQueueInvocationSequence::size ( void  ) const
inline

Get the number of invocations in this sequence.

Definition at line 188 of file OgreRenderQueueInvocation.h.

Member Data Documentation

RenderQueueInvocationList Ogre::RenderQueueInvocationSequence::mInvocations
protected

Definition at line 162 of file OgreRenderQueueInvocation.h.

String Ogre::RenderQueueInvocationSequence::mName
protected

Definition at line 161 of file OgreRenderQueueInvocation.h.


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