Ogre::ParticleAffectorFactory2 Class Reference

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

#include <OgreParticleAffector2.h>

Inheritance diagram for Ogre::ParticleAffectorFactory2:

Public Member Functions
virtual	~ParticleAffectorFactory2 ()=default
virtual ParticleAffector2 *	createAffector ()=0
	Creates a new affector instance. More...
virtual String	getName () const =0
	Returns the name of the factory, the name which identifies the particle affector type this factory creates. More...

Detailed Description

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

Remarks

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

ParticleAffector2Factory subclasses must allow the creation and destruction of ParticleAffector2 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

~ParticleAffectorFactory2()

virtual Ogre::ParticleAffectorFactory2::~ParticleAffectorFactory2 ( )

virtualdefault

Member Function Documentation

createAffector()

virtual ParticleAffector2* Ogre::ParticleAffectorFactory2::createAffector ( )

pure virtual

Creates a new affector instance.

getName()

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

pure virtual

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

---

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

• OgreParticleAffector2.h