MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Mezzanine::Graphics::ParticleEmitter Class Reference

This class defines how particles of a given particle effect spawn. More...

#include <particleemitter.h>

+ Collaboration diagram for Mezzanine::Graphics::ParticleEmitter:

Public Member Functions

 ParticleEmitter (Ogre::ParticleEmitter *InternalEmitter, ParticleSystemProxy *Creator)
 Internal Class constructor. More...
 
virtual ~ParticleEmitter ()
 Class destructor.
 
virtual Ogre::ParticleEmitter * _GetGraphicsEmitter () const
 Accessor for the internal particle emitter. More...
 
String GetCustomParam (const String &Name) const
 Gets a custom parameter of a particle emitter. More...
 
virtual String GetDerivedSerializableName () const
 Gets the most derived serializable name of this WorldProxy. More...
 
virtual void ProtoDeSerialize (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite this object with it. More...
 
virtual void ProtoDeSerializeCustomParameters (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the custom altered parameters of this object with it. More...
 
virtual void ProtoSerialize (XML::Node &ParentNode) const
 Convert this class to an XML::Node ready for serialization. More...
 
virtual void ProtoSerializeCustomParameters (XML::Node &SelfRoot) const
 Convert the custom altered parameters of this class to an XML::Node ready for serialization. More...
 
void SetCustomParam (const String &Name, const String &Value)
 Sets a custom parameter of a particle emitter. More...
 

Static Public Member Functions

static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 

Protected Attributes

NameValuePairMap CustomEmitterParameters
 A cache containing all of the custom altered parameters of this particle emitter. More...
 
Ogre::ParticleEmitter * GraphicsEmitter
 The internal emitter class this class get's it functionality from. More...
 
ParticleSystemProxyParentSystem
 A pointer to the system that this emitter is emitting particles for. More...
 

Detailed Description

This class defines how particles of a given particle effect spawn.

Definition at line 61 of file particleemitter.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::ParticleEmitter::ParticleEmitter ( Ogre::ParticleEmitter *  InternalEmitter,
ParticleSystemProxy Creator 
)

Internal Class constructor.

Parameters
InternalEmitterA pointer to the internal emitter providing this class' functionality.
CreatorA pointer to the particle system that created this emitter.

Definition at line 56 of file particleemitter.cpp.

Member Function Documentation

Ogre::ParticleEmitter * Mezzanine::Graphics::ParticleEmitter::_GetGraphicsEmitter ( ) const
virtual

Accessor for the internal particle emitter.

Returns
Returns a pointer to the internal particle emitter this proxy is based on.

Definition at line 170 of file particleemitter.cpp.

String Mezzanine::Graphics::ParticleEmitter::GetCustomParam ( const String Name) const

Gets a custom parameter of a particle emitter.

Remarks
The params available to change depends on the internal particle emitter used. You should check your particle script where possible to ensure the particle has the param you are looking for.
Parameters
NameThe name of the parameter to fetch.

Definition at line 73 of file particleemitter.cpp.

String Mezzanine::Graphics::ParticleEmitter::GetDerivedSerializableName ( ) const
virtual

Gets the most derived serializable name of this WorldProxy.

Note
When creating a new WorldProxy class verify this method has a valid return for it in order for serialization to work properly.
Returns
Returns the name of the XML tag from the most derived class of "this".

Definition at line 161 of file particleemitter.cpp.

String Mezzanine::Graphics::ParticleEmitter::GetSerializableName ( )
static

Get the name of the the XML tag the proxy class will leave behind as its instances are serialized.

Returns
A string containing the name of this class.

Definition at line 164 of file particleemitter.cpp.

void Mezzanine::Graphics::ParticleEmitter::ProtoDeSerialize ( const XML::Node SelfRoot)
virtual

Take the data stored in an XML Node and overwrite this object with it.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.

Definition at line 116 of file particleemitter.cpp.

void Mezzanine::Graphics::ParticleEmitter::ProtoDeSerializeCustomParameters ( const XML::Node SelfRoot)
virtual

Take the data stored in an XML Node and overwrite the custom altered parameters of this object with it.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.

Definition at line 126 of file particleemitter.cpp.

void Mezzanine::Graphics::ParticleEmitter::ProtoSerialize ( XML::Node ParentNode) const
virtual

Convert this class to an XML::Node ready for serialization.

Parameters
ParentNodeThe point in the XML hierarchy that all this renderable should be appended to.

Definition at line 81 of file particleemitter.cpp.

void Mezzanine::Graphics::ParticleEmitter::ProtoSerializeCustomParameters ( XML::Node SelfRoot) const
virtual

Convert the custom altered parameters of this class to an XML::Node ready for serialization.

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Definition at line 93 of file particleemitter.cpp.

void Mezzanine::Graphics::ParticleEmitter::SetCustomParam ( const String Name,
const String Value 
)

Sets a custom parameter of a particle emitter.

Remarks
The params available to change depends on the internal particle emitter used. You should check your particle script where possible to ensure particles you are changing are the type you expect.
Parameters
NameThe name of the parameter to alter.
ValueThe new value to set for the named parameter.

Definition at line 67 of file particleemitter.cpp.

Member Data Documentation

NameValuePairMap Mezzanine::Graphics::ParticleEmitter::CustomEmitterParameters
protected

A cache containing all of the custom altered parameters of this particle emitter.

Note
Once we have a proper wrapper for particle systems (or our own implementation) this no longer needs to exist.

Definition at line 67 of file particleemitter.h.

Ogre::ParticleEmitter* Mezzanine::Graphics::ParticleEmitter::GraphicsEmitter
protected

The internal emitter class this class get's it functionality from.

Definition at line 70 of file particleemitter.h.

ParticleSystemProxy* Mezzanine::Graphics::ParticleEmitter::ParentSystem
protected

A pointer to the system that this emitter is emitting particles for.

Definition at line 73 of file particleemitter.h.


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