Ogre::DeflectorPlaneAffector2 Class Reference

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

#include <OgreDeflectorPlaneAffector2.h>

Inheritance diagram for Ogre::DeflectorPlaneAffector2:

Public Member Functions
	DeflectorPlaneAffector2 ()
void	_cloneFrom (const ParticleAffector2 *original) override
Real	getBounce () const
	Gets the bounce value of the deflection. More...
Vector3	getPlaneNormal () const
	Gets the plane normal of the deflector plane. More...
Vector3	getPlanePoint () const
	Gets the plane point of the deflector plane. More...
String	getType () const override
	Returns the name of the type of affector. More...
void	run (ParticleCpuData cpuData, size_t numParticles, ArrayReal timeSinceLast) const override
void	setBounce (Real bounce)
	Sets the bounce value of the deflection. 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...
Public Member Functions inherited from Ogre::ParticleAffector2
virtual void	initEmittedParticles (ParticleCpuData, const EmittedParticle *, size_t) const
	Initializes particles Can be called by multiple threads. More...
virtual bool	needsInitialization () const
	Returns true if initEmittedParticles() must be called on a particle that has been emitted. More...
virtual void	oneTimeInit ()
virtual bool	wantsRotation () const
	Returns true if ParticleSystemDef should default to something else other than ParticleRotationType::None. More...
Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()
virtual	~StringInterface ()
	Virtual destructor, see Effective C++. More...
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...
ParamDictionary *	getParamDictionary ()
	Retrieves the parameter dictionary for this class. More...
const ParamDictionary *	getParamDictionary () const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...
const ParameterList &	getParameters () const
	Retrieves a list of parameters valid for this object. More...
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

Additional Inherited Members
Static Public Member Functions inherited from Ogre::StringInterface
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...

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

DeflectorPlaneAffector2()

Ogre::DeflectorPlaneAffector2::DeflectorPlaneAffector2

(

)

Member Function Documentation

_cloneFrom()

void Ogre::DeflectorPlaneAffector2::_cloneFrom ( const ParticleAffector2 *  original )

overridevirtual

Implements Ogre::ParticleAffector2.

getBounce()

Real Ogre::DeflectorPlaneAffector2::getBounce

(

)

const

Gets the bounce value of the deflection.

getPlaneNormal()

Vector3 Ogre::DeflectorPlaneAffector2::getPlaneNormal

(

)

const

Gets the plane normal of the deflector plane.

getPlanePoint()

Vector3 Ogre::DeflectorPlaneAffector2::getPlanePoint

(

)

const

Gets the plane point of the deflector plane.

getType()

String Ogre::DeflectorPlaneAffector2::getType ( ) const

overridevirtual

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.

Implements Ogre::ParticleAffector2.

run()

void Ogre::DeflectorPlaneAffector2::run ( ParticleCpuData  cpuData, size_t  numParticles, ArrayReal  timeSinceLast  ) const

overridevirtual

Implements Ogre::ParticleAffector2.

setBounce()

void Ogre::DeflectorPlaneAffector2::setBounce

(

Real

bounce

)

Sets the bounce value of the deflection.

setPlaneNormal()

void Ogre::DeflectorPlaneAffector2::setPlaneNormal

(

const Vector3 &

normal

)

Sets the plane normal of the deflector plane.

setPlanePoint()

void Ogre::DeflectorPlaneAffector2::setPlanePoint

(

const Vector3 &

pos

)

Sets the plane point of the deflector plane.

---

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

• OgreDeflectorPlaneAffector2.h