OGRE 2.1
Object-Oriented Graphics Rendering Engine
Loading...
Searching...
No Matches
Ogre::DirectionRandomiserAffector Class Reference

This class defines a ParticleAffector which applies randomness to the movement of the particles. More...

#include <OgreDirectionRandomiserAffector.h>

+ Inheritance diagram for Ogre::DirectionRandomiserAffector:

Classes

class  CmdKeepVelocity
 Command object for keep_velocity (see ParamCommand). More...
 
class  CmdRandomness
 Command object for randomness (see ParamCommand). More...
 
class  CmdScope
 Command object for scope (see ParamCommand). More...
 

Public Member Functions

 DirectionRandomiserAffector (ParticleSystem *psys)
 Default constructor.
 
void _affectParticles (ParticleSystem *pSystem, Real timeElapsed)
 See ParticleAffector.
 
virtual void _initParticle (Particle *pParticle)
 Method called to allow the affector to initialize all newly created particles in the system.
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object.
 
bool getKeepVelocity (void) const
 Gets flag which detemines whether particle speed is changed.
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class.
 
const ParamDictionarygetParamDictionary (void) const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method.
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object.
 
Real getRandomness (void) const
 Gets the randomness to apply to the particles in a system.
 
Real getScope (void) const
 Gets the scope (percentage of particles which are randomised).
 
const StringgetType (void) const
 Returns the name of the type of affector.
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
voidoperator new (size_t sz, void *ptr)
 placement operator new
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 
void setKeepVelocity (bool keepVelocity)
 Set flag which detemines whether particle speed is changed.
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method.
 
void setRandomness (Real force)
 Sets the randomness to apply to the particles in a system.
 
void setScope (Real force)
 Sets the scope (percentage of particles which are randomised).
 

Static Public Member Functions

static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
 

Static Public Attributes

static CmdKeepVelocity msKeepVelocityCmd
 
static CmdRandomness msRandomnessCmd
 Command objects.
 
static CmdScope msScopeCmd
 

Detailed Description

This class defines a ParticleAffector which applies randomness to the movement of the particles.

Remarks
This affector (see ParticleAffector) applies randomness to the movement of the particles by changing the direction vectors.
The most important parameter to control the effect is randomness. It controls the range in which changes are applied to each axis of the direction vector. The parameter scope can be used to limit the effect to a certain percentage of the particles.

Constructor & Destructor Documentation

◆ DirectionRandomiserAffector()

Ogre::DirectionRandomiserAffector::DirectionRandomiserAffector ( ParticleSystem psys)

Default constructor.

Member Function Documentation

◆ _affectParticles()

void Ogre::DirectionRandomiserAffector::_affectParticles ( ParticleSystem pSystem,
Real  timeElapsed 
)
virtual

◆ _initParticle()

virtual void Ogre::ParticleAffector::_initParticle ( Particle pParticle)
inlinevirtualinherited

Method called to allow the affector to initialize all newly created particles in the system.

Remarks
This is where the affector gets the chance to initialize it's effects to the particles of a system. The affector is expected to initialize some or all of the particles in the system passed to it, depending on the affector's approach.
Parameters
pParticlePointer to a Particle to initialize.

Reimplemented in Ogre::ColourImageAffector, and Ogre::RotationAffector.

◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )
staticinherited

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

MaterialManager) initializes.

◆ copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

Method for copying this object's parameters to another object.

Remarks
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters
destPointer to object to have it's parameters set the same as this object.

◆ getKeepVelocity()

bool Ogre::DirectionRandomiserAffector::getKeepVelocity ( void  ) const

Gets flag which detemines whether particle speed is changed.

◆ getParamDictionary() [1/2]

ParamDictionary * Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

Retrieves the parameter dictionary for this class.

Remarks
Only valid to call this after createParamDictionary.
Returns
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

◆ getParamDictionary() [2/2]

const ParamDictionary * Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

◆ getParameter()

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

Generic parameter retrieval method.

Remarks
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

◆ getParameters()

const ParameterList & Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.

◆ getRandomness()

Real Ogre::DirectionRandomiserAffector::getRandomness ( void  ) const

Gets the randomness to apply to the particles in a system.

◆ getScope()

Real Ogre::DirectionRandomiserAffector::getScope ( void  ) const

Gets the scope (percentage of particles which are randomised).

◆ getType()

const String & Ogre::ParticleAffector::getType ( void  ) const
inlineinherited

Returns the name of the type of affector.

Remarks
This property is useful for determining the type of affector procedurally so another can be created.

◆ operator delete() [1/3]

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

◆ operator delete() [2/3]

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

◆ operator delete() [3/3]

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

◆ operator delete[]() [1/2]

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

◆ operator delete[]() [2/2]

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

◆ operator new() [1/3]

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

◆ operator new() [2/3]

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

◆ operator new() [3/3]

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

placement operator new

◆ operator new[]() [1/2]

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

◆ operator new[]() [2/2]

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

◆ setKeepVelocity()

void Ogre::DirectionRandomiserAffector::setKeepVelocity ( bool  keepVelocity)

Set flag which detemines whether particle speed is changed.

◆ setParameter()

virtual bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
virtualinherited

Generic parameter setting method.

Remarks
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

◆ setParameterList()

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
virtualinherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
paramListName/value pair list

◆ setRandomness()

void Ogre::DirectionRandomiserAffector::setRandomness ( Real  force)

Sets the randomness to apply to the particles in a system.

◆ setScope()

void Ogre::DirectionRandomiserAffector::setScope ( Real  force)

Sets the scope (percentage of particles which are randomised).

Member Data Documentation

◆ msKeepVelocityCmd

CmdKeepVelocity Ogre::DirectionRandomiserAffector::msKeepVelocityCmd
static

◆ msRandomnessCmd

CmdRandomness Ogre::DirectionRandomiserAffector::msRandomnessCmd
static

Command objects.

◆ msScopeCmd

CmdScope Ogre::DirectionRandomiserAffector::msScopeCmd
static

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