OGRE: Ogre::ParticleAffectorFactory Class Reference - OGRE Documentation

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

# Ogre::ParticleAffectorFactory Class Reference

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

`#include <OgreParticleAffectorFactory.h>`

List of all members.

## Public Member Functions

| ParticleAffectorFactory ()
virtual | ~ParticleAffectorFactory ()
virtual String | getName () const =0
| Returns the name of the factory, the name which identifies the particle affector type this factory creates.
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 reauired).

## Protected Attributes

std::vector< ParticleAffector * > | mAffectors

## 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.

Definition at line 49 of file OgreParticleAffectorFactory.h.

## Constructor & Destructor Documentation

Ogre::ParticleAffectorFactory::ParticleAffectorFactory | ( |  | ) |

| Definition at line 54 of file OgreParticleAffectorFactory.h.

virtual Ogre::ParticleAffectorFactory::~ParticleAffectorFactory | ( |  | ) | `[virtual]`

## Member Function Documentation

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.

virtual void Ogre::ParticleAffectorFactory::destroyAffector | ( | ParticleAffector * | e | ) | `[virtual]`

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

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.

## Member Data Documentation

std::vector<ParticleAffector*> Ogre::ParticleAffectorFactory::mAffectors`[protected]`

| Definition at line 52 of file OgreParticleAffectorFactory.h.

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

- OgreParticleAffectorFactory.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Thu Mar 6 09:47:35 2008