OGRE
1.9.0
|
Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances. More...
#include <OgreParticleSystemRenderer.h>
Public Member Functions | |
ParticleSystemRenderer () | |
Constructor. | |
virtual | ~ParticleSystemRenderer () |
Destructor. | |
virtual ParticleVisualData * | _createVisualData (void) |
Create a new ParticleVisualData instance for attachment to a particle. | |
virtual void | _destroyVisualData (ParticleVisualData *vis) |
Destroy a ParticleVisualData instance. | |
virtual SortMode | _getSortMode (void) const =0 |
Gets the desired particles sort mode of this renderer. | |
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false)=0 |
Delegated to by ParticleSystem::_notifyAttached. | |
virtual void | _notifyCurrentCamera (Camera *cam)=0 |
Delegated to by ParticleSystem::_notifyCurrentCamera. | |
virtual void | _notifyDefaultDimensions (Real width, Real height)=0 |
Tells the renderer that the particle default size has changed. | |
virtual void | _notifyParticleCleared (list< Particle * >::type ¤tParticles) |
Optional callback notified when particles cleared. | |
virtual void | _notifyParticleEmitted (Particle *particle) |
Optional callback notified when particle emitted. | |
virtual void | _notifyParticleExpired (Particle *particle) |
Optional callback notified when particle expired. | |
virtual void | _notifyParticleMoved (list< Particle * >::type ¤tParticles) |
Optional callback notified when particles moved. | |
virtual void | _notifyParticleQuota (size_t quota)=0 |
Tells the renderer that the particle quota has changed. | |
virtual void | _notifyParticleResized (void) |
Optional callback notified when particles are resized individually. | |
virtual void | _notifyParticleRotated (void) |
Optional callback notified when particles are rotated. | |
virtual void | _setMaterial (MaterialPtr &mat)=0 |
Sets the material this renderer must use; called by ParticleSystem. | |
virtual void | _updateRenderQueue (RenderQueue *queue, list< Particle * >::type ¤tParticles, bool cullIndividually)=0 |
Delegated to by ParticleSystem::_updateRenderQueue. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual const String & | getType (void) const =0 |
Gets the type of this renderer - must be implemented by subclasses. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
virtual void | setKeepParticlesInLocalSpace (bool keepLocal)=0 |
Setting carried over from ParticleSystem. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual void | setRenderQueueGroup (uint8 queueID)=0 |
Sets which render queue group this renderer should target with it's output. | |
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)=0 |
Sets which render queue group and priority this renderer should target with it's output. | |
virtual void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)=0 |
Required method to allow the renderer to communicate the Renderables it will be using to render the system to a visitor. | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. | |
Protected Member Functions | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Private Member Functions | |
OGRE_STATIC_MUTEX (msDictionaryMutex) | |
Private Attributes | |
ParamDictionary * | mParamDict |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses) | |
Static Private Attributes | |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances.
Definition at line 49 of file OgreParticleSystemRenderer.h.
Ogre::ParticleSystemRenderer::ParticleSystemRenderer | ( | ) |
Constructor.
Definition at line 53 of file OgreParticleSystemRenderer.h.
|
virtual |
Destructor.
Definition at line 55 of file OgreParticleSystemRenderer.h.
|
virtual |
Create a new ParticleVisualData instance for attachment to a particle.
Definition at line 97 of file OgreParticleSystemRenderer.h.
|
virtual |
Destroy a ParticleVisualData instance.
Definition at line 105 of file OgreParticleSystemRenderer.h.
Gets the desired particles sort mode of this renderer.
Implemented in Ogre::BillboardParticleRenderer.
|
pure virtual |
Delegated to by ParticleSystem::_notifyAttached.
Implemented in Ogre::BillboardParticleRenderer.
Delegated to by ParticleSystem::_notifyCurrentCamera.
Implemented in Ogre::BillboardParticleRenderer.
|
pure virtual |
Tells the renderer that the particle default size has changed.
Implemented in Ogre::BillboardParticleRenderer.
|
virtual |
Optional callback notified when particles cleared.
Definition at line 89 of file OgreParticleSystemRenderer.h.
Optional callback notified when particle emitted.
Definition at line 83 of file OgreParticleSystemRenderer.h.
Optional callback notified when particle expired.
Definition at line 85 of file OgreParticleSystemRenderer.h.
|
virtual |
Optional callback notified when particles moved.
Definition at line 87 of file OgreParticleSystemRenderer.h.
Tells the renderer that the particle quota has changed.
Implemented in Ogre::BillboardParticleRenderer.
Optional callback notified when particles are resized individually.
Reimplemented in Ogre::BillboardParticleRenderer.
Definition at line 77 of file OgreParticleSystemRenderer.h.
Optional callback notified when particles are rotated.
Reimplemented in Ogre::BillboardParticleRenderer.
Definition at line 75 of file OgreParticleSystemRenderer.h.
|
pure virtual |
Sets the material this renderer must use; called by ParticleSystem.
Implemented in Ogre::BillboardParticleRenderer.
|
pure virtual |
Delegated to by ParticleSystem::_updateRenderQueue.
Implemented in Ogre::BillboardParticleRenderer.
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
|
virtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
inherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inherited |
Definition at line 224 of file OgreStringInterface.h.
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
|
inherited |
Retrieves a list of parameters valid for this object.
Gets the type of this renderer - must be implemented by subclasses.
Implemented in Ogre::BillboardParticleRenderer.
|
privateinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
pure virtual |
Setting carried over from ParticleSystem.
Implemented in Ogre::BillboardParticleRenderer.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
Sets which render queue group this renderer should target with it's output.
Implemented in Ogre::BillboardParticleRenderer.
|
pure virtual |
Sets which render queue group and priority this renderer should target with it's output.
Implemented in Ogre::BillboardParticleRenderer.
|
pure virtual |
Required method to allow the renderer to communicate the Renderables it will be using to render the system to a visitor.
Implemented in Ogre::BillboardParticleRenderer.
|
privateinherited |
Definition at line 173 of file OgreStringInterface.h.
|
privateinherited |
Class name for this instance to be used as a lookup (must be initialised by subclasses)
Definition at line 172 of file OgreStringInterface.h.
|
staticprivateinherited |
Dictionary of parameters.
Definition at line 169 of file OgreStringInterface.h.