RigsofRods
Soft-body Physics Simulation
Data Structures | Public Member Functions | Static Public Attributes | Protected Attributes
Ogre::FireExtinguisherAffector Class Reference

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

#include <FireExtinguisherAffector.h>

+ Inheritance diagram for Ogre::FireExtinguisherAffector:
+ Collaboration diagram for Ogre::FireExtinguisherAffector:

Data Structures

class  CmdEffectiveness
 Command object for bounce (see ParamCommand). More...
 

Public Member Functions

 FireExtinguisherAffector (ParticleSystem *psys)
 Default constructor. More...
 
void _affectParticles (ParticleSystem *pSystem, Real timeElapsed)
 See ParticleAffector. More...
 
void setEffectiveness (Real effectiveness)
 Sets the bounce value of the deflection. More...
 
Real getEffectiveness (void) const
 Gets the bounce value of the deflection. More...
 

Static Public Attributes

static CmdEffectiveness msEffectivenessCmd
 Command objects. More...
 

Protected Attributes

ExtinguishableFireAffectorFactorymEfaf
 
Real mEffectiveness
 effectiveness factor (1 means as effective as water, everything higher is more effective while anything lower is less effective) 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 strenght of the recoil by using the bounce parameter.

Definition at line 46 of file FireExtinguisherAffector.h.

Constructor & Destructor Documentation

◆ FireExtinguisherAffector()

Ogre::FireExtinguisherAffector::FireExtinguisherAffector ( ParticleSystem *  psys)

Default constructor.

Definition at line 42 of file FireExtinguisherAffector.cpp.

Member Function Documentation

◆ _affectParticles()

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

See ParticleAffector.

Definition at line 78 of file FireExtinguisherAffector.cpp.

+ Here is the call graph for this function:

◆ getEffectiveness()

Real Ogre::FireExtinguisherAffector::getEffectiveness ( void  ) const

Gets the bounce value of the deflection.

Definition at line 120 of file FireExtinguisherAffector.cpp.

+ Here is the caller graph for this function:

◆ setEffectiveness()

void Ogre::FireExtinguisherAffector::setEffectiveness ( Real  effectiveness)

Sets the bounce value of the deflection.

Definition at line 115 of file FireExtinguisherAffector.cpp.

+ Here is the caller graph for this function:

Field Documentation

◆ mEfaf

ExtinguishableFireAffectorFactory* Ogre::FireExtinguisherAffector::mEfaf
protected

Definition at line 74 of file FireExtinguisherAffector.h.

◆ mEffectiveness

Real Ogre::FireExtinguisherAffector::mEffectiveness
protected

effectiveness factor (1 means as effective as water, everything higher is more effective while anything lower is less effective)

Definition at line 77 of file FireExtinguisherAffector.h.

◆ msEffectivenessCmd

FireExtinguisherAffector::CmdEffectiveness Ogre::FireExtinguisherAffector::msEffectivenessCmd
static

Command objects.

Definition at line 70 of file FireExtinguisherAffector.h.


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