This class defines a ParticleAffector which deflects particles. More...

#include <OgreDeflectorPlaneAffector.h>

Inheritance diagram for Ogre::DeflectorPlaneAffector:

Classes
class	CmdBounce
	Command object for bounce (see ParamCommand). More...

class	CmdPlaneNormal
	Command object for plane normal (see ParamCommand). More...

class	CmdPlanePoint
	Command object for plane point (see ParamCommand). More...

Public Member Functions
	DeflectorPlaneAffector (ParticleSystem *psys)
	Default constructor. More...

void	_affectParticles (ParticleSystem *pSystem, Real timeElapsed)
	See ParticleAffector. More...

virtual void	_initParticle (Particle *pParticle)
	Method called to allow the affector to initialize all newly created particles in the system. More...

void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...

Real	getBounce (void) const
	Gets the bounce value of the deflection. More...

ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...

const ParamDictionary *	getParamDictionary (void) const

String	getParameter (const String &name) const
	Generic parameter retrieval method. More...

const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object. More...

Vector3	getPlaneNormal (void) const
	Gets the plane normal of the deflector plane. More...

Vector3	getPlanePoint (void) const
	Gets the plane point of the deflector plane. More...

const String &	getType (void) const
	Returns the name of the type of affector. More...

void	setBounce (Real bounce)
	Sets the bounce value of the deflection. More...

bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...

void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

void	setPlaneNormal (const Vector3 &normal)
	Sets the plane normal of the deflector plane. More...

void	setPlanePoint (const Vector3 &pos)
	Sets the plane point of the deflector plane. More...

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

Static Public Attributes
static CmdBounce	msBounceCmd

static CmdPlaneNormal	msPlaneNormalCmd

static CmdPlanePoint	msPlanePointCmd
	Command objects. More...

Detailed Description

This class defines a ParticleAffector which deflects particles.

Remarks: This affector (see ParticleAffector) offers a simple (and inaccurate) physical deflection. All particles which hit the plane are reflected.

: The plane is defined by a point (plane_point) and the normal (plane_normal). In addition it is possible to change the strength of the recoil by using the bounce parameter.

Constructor & Destructor Documentation

◆ DeflectorPlaneAffector()

Ogre::DeflectorPlaneAffector::DeflectorPlaneAffector ( ParticleSystem * psys )

Default constructor.

Member Function Documentation

◆ _affectParticles()

void Ogre::DeflectorPlaneAffector::_affectParticles	(	ParticleSystem *	pSystem,
		Real	timeElapsed
	)

virtual

See ParticleAffector.

Implements Ogre::ParticleAffector.

◆ setPlanePoint()

void Ogre::DeflectorPlaneAffector::setPlanePoint ( const Vector3 & pos )

Sets the plane point of the deflector plane.

◆ getPlanePoint()

Vector3 Ogre::DeflectorPlaneAffector::getPlanePoint ( void ) const

Gets the plane point of the deflector plane.

◆ setPlaneNormal()

void Ogre::DeflectorPlaneAffector::setPlaneNormal ( const Vector3 & normal )

Sets the plane normal of the deflector plane.

◆ getPlaneNormal()

Vector3 Ogre::DeflectorPlaneAffector::getPlaneNormal ( void ) const

Gets the plane normal of the deflector plane.

◆ setBounce()

void Ogre::DeflectorPlaneAffector::setBounce ( Real bounce )

Sets the bounce value of the deflection.

◆ getBounce()

Real Ogre::DeflectorPlaneAffector::getBounce ( void ) const

Gets the bounce value of the deflection.

◆ _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

pParticle Pointer to a Particle to initialize.

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

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

◆ 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

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

◆ setParameter()

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

inherited

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

name	The name of the parameter to set
value	String 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)

Referenced by Ogre::StringInterface::copyParametersTo().

◆ setParameterList()

void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList )

inherited

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

paramList Name/value pair list

◆ getParameter()

String Ogre::StringInterface::getParameter ( const String & name ) const

inlineinherited

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

name	The name of the parameter to get

Returns: String value of parameter, blank if not found

References Ogre::ParamCommand::doGet().

◆ copyParametersTo()

void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const

inlineinherited

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

dest	Pointer to object to have it's parameters set the same as this object.

References Ogre::StringInterface::setParameter().

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

Member Data Documentation

◆ msPlanePointCmd

CmdPlanePoint Ogre::DeflectorPlaneAffector::msPlanePointCmd

static

Command objects.

◆ msPlaneNormalCmd

CmdPlaneNormal Ogre::DeflectorPlaneAffector::msPlaneNormalCmd

static

◆ msBounceCmd

CmdBounce Ogre::DeflectorPlaneAffector::msBounceCmd

static

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

OgreDeflectorPlaneAffector.h

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DeflectorPlaneAffector()

Member Function Documentation

◆ _affectParticles()

◆ setPlanePoint()

◆ getPlanePoint()

◆ setPlaneNormal()

◆ getPlaneNormal()

◆ setBounce()

◆ getBounce()

◆ _initParticle()

◆ getType()

◆ getParamDictionary() [1/2]

◆ getParamDictionary() [2/2]

◆ getParameters()

◆ setParameter()

◆ setParameterList()

◆ getParameter()

◆ copyParametersTo()

◆ cleanupDictionary()

Member Data Documentation

◆ msPlanePointCmd

◆ msPlaneNormalCmd

◆ msBounceCmd