OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::DeflectorPlaneAffector Class Reference

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...
 
Real getBounce (void) const
 Gets the bounce value of the deflection. 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...
 
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::ParticleAffector
 ParticleAffector (ParticleSystem *parent)
 
virtual ~ParticleAffector ()
 Virtual destructor essential. More...
 
virtual void _initParticle (Particle *pParticle)
 Method called to allow the affector to initialize all newly created particles in the system. More...
 
const StringgetType (void) const
 Returns the name of the type of affector. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. 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...
 

Static Public Attributes

static CmdBounce msBounceCmd
 
static CmdPlaneNormal msPlaneNormalCmd
 
static CmdPlanePoint msPlanePointCmd
 Command objects. 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

◆ DeflectorPlaneAffector()

Ogre::DeflectorPlaneAffector::DeflectorPlaneAffector ( ParticleSystem psys)

Default constructor.

Member Function Documentation

◆ _affectParticles()

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

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

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: