OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
Ogre::ParticleAffectorFactory Class Referenceabstract
Effects

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

#include <OgreParticleAffectorFactory.h>

+ Inheritance diagram for Ogre::ParticleAffectorFactory:
+ Collaboration diagram for Ogre::ParticleAffectorFactory:

Public Member Functions

 ParticleAffectorFactory ()
 
virtual ~ParticleAffectorFactory ()
 
virtual ParticleAffector * createAffector (ParticleSystem *psys)=0
 Creates a new affector instance. More...
 
virtual void destroyAffector (ParticleAffector *e)
 Destroys the affector pointed to by the parameter (for early clean up if required). More...
 
virtual String getName () const =0
 Returns the name of the factory, the name which identifies the particle affector type this factory creates. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

Protected Attributes

vector< ParticleAffector * >::type 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 55 of file OgreParticleAffectorFactory.h.

Constructor & Destructor Documentation

Ogre::ParticleAffectorFactory::ParticleAffectorFactory ( )
inline

Definition at line 60 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.

Implemented in Ogre::ColourFaderAffectorFactory, Ogre::ColourFaderAffectorFactory2, Ogre::ColourImageAffectorFactory, Ogre::ColourInterpolatorAffectorFactory, Ogre::DeflectorPlaneAffectorFactory, Ogre::DirectionRandomiserAffectorFactory, Ogre::LinearForceAffectorFactory, Ogre::RotationAffectorFactory, and Ogre::ScaleAffectorFactory.

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

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

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.

Implemented in Ogre::ColourFaderAffectorFactory, Ogre::ColourFaderAffectorFactory2, Ogre::ColourImageAffectorFactory, Ogre::ColourInterpolatorAffectorFactory, Ogre::DeflectorPlaneAffectorFactory, Ogre::DirectionRandomiserAffectorFactory, Ogre::LinearForceAffectorFactory, Ogre::RotationAffectorFactory, and Ogre::ScaleAffectorFactory.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

Definition at line 68 of file OgreMemoryAllocatedObject.h.

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

vector<ParticleAffector*>::type Ogre::ParticleAffectorFactory::mAffectors
protected

Definition at line 58 of file OgreParticleAffectorFactory.h.

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