Ogre::ParticleAffectorFactory Class Reference

Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses. More...

#include <OgreParticleAffectorFactory.h>

Inheritance diagram for Ogre::ParticleAffectorFactory:

Public Member Functions
	ParticleAffectorFactory ()
virtual	~ParticleAffectorFactory ()
virtual ParticleAffector *	createAffector (ParticleSystem *psys)=0
	Creates a new affector instance.
virtual void	destroyAffector (ParticleAffector *e)
	Destroys the affector pointed to by the parameter (for early clean up if required).
virtual String	getName () const =0
	Returns the name of the factory, the name which identifies the particle affector type this factory creates.
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

Detailed Description

Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses.

Remarks

Plugins or 3rd party applications can add new types of particle affectors to Ogre by creating subclasses of the ParticleAffector class. Because multiple instances of these affectors may be required, a factory class to manage the instances is also required.

ParticleAffectorFactory subclasses must allow the creation and destruction of ParticleAffector subclasses. They must also be registered with the ParticleSystemManager. All factories have a name which identifies them, examples might be 'force_vector', 'attractor', or 'fader', and these can be also be used from particle system scripts.

Constructor & Destructor Documentation

ParticleAffectorFactory()

Ogre::ParticleAffectorFactory::ParticleAffectorFactory ( )

inline

~ParticleAffectorFactory()

virtual Ogre::ParticleAffectorFactory::~ParticleAffectorFactory ( )

virtual

Member Function Documentation

createAffector()

virtual ParticleAffector * Ogre::ParticleAffectorFactory::createAffector ( ParticleSystem *  psys )

pure virtual

Creates a new affector instance.

Remarks

The subclass MUST add a pointer to the created instance to mAffectors.

destroyAffector()

virtual void Ogre::ParticleAffectorFactory::destroyAffector ( ParticleAffector *  e )

virtual

Destroys the affector pointed to by the parameter (for early clean up if required).

getName()

virtual String Ogre::ParticleAffectorFactory::getName ( ) const

pure virtual

Returns the name of the factory, the name which identifies the particle affector type this factory creates.

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

---

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

• OgreParticleAffectorFactory.h