Ogre::ParticleSystemRenderer Class Reference

Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances. More...

#include <OgreParticleSystemRenderer.h>

Inheritance diagram for Ogre::ParticleSystemRenderer:

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)=0
	Delegated to by ParticleSystem::_notifyAttached.
virtual void	_notifyCurrentCamera (const 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 &currentParticles)
	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 &currentParticles)
	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	_setDatablock (HlmsDatablock *datablock)=0
	Sets the HLMS material this renderer must use; called by ParticleSystem.
virtual void	_setMaterialName (const String &matName, const String &resourceGroup)=0
	Sets the material this renderer must use; called by ParticleSystem.
virtual void	_updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera, list< Particle * >::type &currentParticles, bool cullIndividually, RenderableArray &outRenderables)=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 &paramList)
	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	setRenderQueueSubGroup (uint8 subGroupId)=0

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.

Detailed Description

Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances.

Constructor & Destructor Documentation

ParticleSystemRenderer()

Ogre::ParticleSystemRenderer::ParticleSystemRenderer ( )

inline

Constructor.

~ParticleSystemRenderer()

virtual Ogre::ParticleSystemRenderer::~ParticleSystemRenderer ( )

inlinevirtual

Destructor.

Member Function Documentation

_createVisualData()

virtual ParticleVisualData * Ogre::ParticleSystemRenderer::_createVisualData ( void  )

inlinevirtual

Create a new ParticleVisualData instance for attachment to a particle.

Remarks

If this renderer needs additional data in each particle, then this should be held in an instance of a subclass of ParticleVisualData, and this method should be overridden to return a new instance of it. The default behaviour is to return null.

_destroyVisualData()

virtual void Ogre::ParticleSystemRenderer::_destroyVisualData ( ParticleVisualData *  vis )

inlinevirtual

Destroy a ParticleVisualData instance.

Remarks

If this renderer needs additional data in each particle, then this should be held in an instance of a subclass of ParticleVisualData, and this method should be overridden to destroy an instance of it. The default behaviour is to do nothing.

_getSortMode()

virtual SortMode Ogre::ParticleSystemRenderer::_getSortMode ( void  ) const

pure virtual

Gets the desired particles sort mode of this renderer.

Implemented in Ogre::v1::BillboardParticleRenderer.

_notifyAttached()

virtual void Ogre::ParticleSystemRenderer::_notifyAttached ( Node *  parent )

pure virtual

Delegated to by ParticleSystem::_notifyAttached.

Implemented in Ogre::v1::BillboardParticleRenderer.

_notifyCurrentCamera()

virtual void Ogre::ParticleSystemRenderer::_notifyCurrentCamera ( const Camera *  cam )

pure virtual

Delegated to by ParticleSystem::_notifyCurrentCamera.

Implemented in Ogre::v1::BillboardParticleRenderer.

_notifyDefaultDimensions()

virtual void Ogre::ParticleSystemRenderer::_notifyDefaultDimensions ( Real  width, Real  height  )

pure virtual

Tells the renderer that the particle default size has changed.

Implemented in Ogre::v1::BillboardParticleRenderer.

_notifyParticleCleared()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleCleared ( list< Particle * >::type &  currentParticles )

inlinevirtual

Optional callback notified when particles cleared.

_notifyParticleEmitted()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleEmitted ( Particle *  particle )

inlinevirtual

Optional callback notified when particle emitted.

_notifyParticleExpired()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleExpired ( Particle *  particle )

inlinevirtual

Optional callback notified when particle expired.

_notifyParticleMoved()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleMoved ( list< Particle * >::type &  currentParticles )

inlinevirtual

Optional callback notified when particles moved.

_notifyParticleQuota()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleQuota ( size_t  quota )

pure virtual

Tells the renderer that the particle quota has changed.

Implemented in Ogre::v1::BillboardParticleRenderer.

_notifyParticleResized()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleResized ( void  )

inlinevirtual

Optional callback notified when particles are resized individually.

Reimplemented in Ogre::v1::BillboardParticleRenderer.

_notifyParticleRotated()

virtual void Ogre::ParticleSystemRenderer::_notifyParticleRotated ( void  )

inlinevirtual

Optional callback notified when particles are rotated.

Reimplemented in Ogre::v1::BillboardParticleRenderer.

_setDatablock()

virtual void Ogre::ParticleSystemRenderer::_setDatablock ( HlmsDatablock *  datablock )

pure virtual

Sets the HLMS material this renderer must use; called by ParticleSystem.

Implemented in Ogre::v1::BillboardParticleRenderer.

_setMaterialName()

virtual void Ogre::ParticleSystemRenderer::_setMaterialName ( const String &  matName, const String &  resourceGroup  )

pure virtual

Sets the material this renderer must use; called by ParticleSystem.

Implemented in Ogre::v1::BillboardParticleRenderer.

_updateRenderQueue()

virtual void Ogre::ParticleSystemRenderer::_updateRenderQueue ( RenderQueue *  queue, Camera *  camera, const Camera *  lodCamera, list< Particle * >::type &  currentParticles, bool  cullIndividually, RenderableArray &  outRenderables  )

pure virtual

Delegated to by ParticleSystem::_updateRenderQueue.

Remarks

The subclass must update the render queue using whichever Renderable instance(s) it wishes.

Implemented in Ogre::v1::BillboardParticleRenderer.

cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )

staticinherited

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.

copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface *  dest ) const

inlinevirtualinherited

Method for copying this object's parameters to another object.

Remarks

This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

Any unrecognised parameters will be ignored as with setParameter method.

Parameters

dest	Pointer to object to have it's parameters set the same as this object.

getParamDictionary() [1/2]

ParamDictionary * Ogre::StringInterface::getParamDictionary ( void  )

inlineinherited

Retrieves the parameter dictionary for this class.

Remarks

Only valid to call this after createParamDictionary.

Returns

Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

getParamDictionary() [2/2]

const ParamDictionary * Ogre::StringInterface::getParamDictionary ( void  ) const

inlineinherited

getParameter()

virtual String Ogre::StringInterface::getParameter ( const String &  name ) const

inlinevirtualinherited

Generic parameter retrieval method.

Remarks

Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters

name	The name of the parameter to get

Returns

String value of parameter, blank if not found

getParameters()

const ParameterList & Ogre::StringInterface::getParameters ( void  ) const

inherited

Retrieves a list of parameters valid for this object.

Returns

A reference to a static list of ParameterDef objects.

getType()

virtual const String & Ogre::ParticleSystemRenderer::getType ( void  ) const

pure virtual

Gets the type of this renderer - must be implemented by subclasses.

Implemented in Ogre::v1::BillboardParticleRenderer.

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

setKeepParticlesInLocalSpace()

virtual void Ogre::ParticleSystemRenderer::setKeepParticlesInLocalSpace ( bool  keepLocal )

pure virtual

Setting carried over from ParticleSystem.

Implemented in Ogre::v1::BillboardParticleRenderer.

setParameter()

virtual bool Ogre::StringInterface::setParameter ( const String &  name, const String &  value  )

virtualinherited

Generic parameter setting method.

Remarks

Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

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.

Returns

true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

setParameterList()

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList &  paramList )

virtualinherited

Generic multiple parameter setting method.

Remarks

Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

paramList

Name/value pair list

setRenderQueueGroup()

virtual void Ogre::ParticleSystemRenderer::setRenderQueueGroup ( uint8  queueID )

pure virtual

Sets which render queue group this renderer should target with it's output.

Implemented in Ogre::v1::BillboardParticleRenderer.

setRenderQueueSubGroup()

virtual void Ogre::ParticleSystemRenderer::setRenderQueueSubGroup ( uint8  subGroupId )

pure virtual

Implemented in Ogre::v1::BillboardParticleRenderer.

---

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

• OgreParticleSystemRenderer.h