Ogre::ParticleEmitterDefDataFactory Class Reference

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

#include <OgreEmitter2.h>

Inheritance diagram for Ogre::ParticleEmitterDefDataFactory:

Public Member Functions
virtual	~ParticleEmitterDefDataFactory ()=default
virtual EmitterDefData *	createEmitter ()=0
	Creates a new emitter instance.
virtual const String &	getName () const =0
	Returns the name of the factory, the name which identifies the particle emitter type this factory creates.

Detailed Description

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

Remarks

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

ParticleEmitterDefDataFactory subclasses must allow the creation and destruction of EmitterDefData subclasses. They must also be registered with the ParticleSystemManager2. All factories have a name which identifies them, examples might be 'point', 'cone', or 'box', and these can be also be used from particle system scripts.

Constructor & Destructor Documentation

~ParticleEmitterDefDataFactory()

virtual Ogre::ParticleEmitterDefDataFactory::~ParticleEmitterDefDataFactory ( )

virtualdefault

Member Function Documentation

createEmitter()

virtual EmitterDefData * Ogre::ParticleEmitterDefDataFactory::createEmitter ( )

pure virtual

Creates a new emitter instance.

Implemented in Ogre::BoxEmitterFactory2, Ogre::CylinderEmitterFactory2, Ogre::EllipsoidEmitterFactory2, Ogre::HollowEllipsoidEmitterFactory2, Ogre::PointEmitterFactory2, and Ogre::RingEmitterFactory2.

getName()

virtual const String & Ogre::ParticleEmitterDefDataFactory::getName ( ) const

pure virtual

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

Implemented in Ogre::BoxEmitterFactory2, Ogre::CylinderEmitterFactory2, Ogre::EllipsoidEmitterFactory2, Ogre::HollowEllipsoidEmitterFactory2, Ogre::PointEmitterFactory2, and Ogre::RingEmitterFactory2.

---

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

• OgreEmitter2.h