Smoke Emitter. More...
#include <deSmokeEmitter.h>
Public Member Functions | |
Constructors and Destructors | |
| deSmokeEmitter (deSmokeEmitterManager *manager) | |
| Creates a new particle system. | |
| virtual | ~deSmokeEmitter () |
| Cleans up the particle system. | |
Management | |
| const decDVector & | GetEmitterPosition () const |
| Retrieves the emitter position. | |
| void | SetEmitterPosition (const decDVector &position) |
| Sets the emitter position. | |
| const decQuaternion & | GetEmitterOrientation () const |
| Retrieves the emitter orientation. | |
| void | SetEmitterOrientation (const decQuaternion &orientation) |
| Sets the emitter orientation. | |
| const decDVector & | GetVolumePosition () const |
| Retrieves the volume position. | |
| void | SetVolumePosition (const decDVector &position) |
| Sets the volume position. | |
| const decVector & | GetMinCastDirection () const |
| Retrieves the minimum cast direction deviation. | |
| void | SetMinCastDirection (const decVector &deviation) |
| Sets the minimum cast direction deviation. | |
| const decVector & | GetMaxCastDirection () const |
| Retrieves the maximum cast direction deviation. | |
| void | SetMaxCastDirection (const decVector &deviation) |
| Sets the maximum cast direction deviation. | |
| float | GetMinCastVelocity () const |
| Retrieves the minimum cast velocity. | |
| void | SetMinCastVelocity (float velocity) |
| Sets the minimum cast velocity. | |
| float | GetMaxCastVelocity () const |
| Retrieves the maximum cast velocity. | |
| void | SetMaxCastVelocity (float velocity) |
| Sets the maximum cast velocity. | |
| float | GetMinCastDensity () const |
| Retrieves the minimum cast density. | |
| void | SetMinCastDensity (float density) |
| Sets the minimum cast density. | |
| float | GetMaxCastDensity () const |
| Retrieves the maximum cast density. | |
| void | SetMaxCastDensity (float density) |
| Sets the maximum cast density. | |
| bool | GetEnableCasting () const |
| Determines if casting particles is enabled. | |
| void | SetEnableCasting (bool enable) |
| Sets if casting particles is enabled. | |
| deComponent * | GetComponent () const |
| Retrieves the component used for casting or NULL. | |
| void | SetComponent (deComponent *component) |
| Sets the component used for casting or NULL. | |
| int | GetCastTexture () const |
| Retrieves the texture to use from the component skin to cast particles from. | |
| void | SetCastTexture (int texture) |
| Sets the texture to use from the component skin to cast particles from. | |
| deSkin * | GetSkin () const |
| Retrieves the skin of the particle instances or NULL. | |
| void | SetSkin (deSkin *skin) |
| Sets the mode of the particle instances or NULL. | |
| decLayerMask & | GetLayerMask () |
| Retrieves the layer mask. | |
| void | NotifyLayerMaskChanged () |
| Notifies the peers that the layer mask changed. | |
| int | GetGroupNumber () const |
| Retrieves the group number or 0 if not set. | |
| void | SetGroupNumber (int groupNumber) |
| Sets the group number or 0 if not set. | |
| bool | CanHit (const decLayerMask &layerMask, int groupNumber) const |
| Determines if a particle instance can be hit by another object represented by a layer mask and a group number. | |
| const decVector & | GetGravity () const |
| Retrieves the gravity in m/s^2. | |
| void | SetGravity (const decVector &gravity) |
| Sets the gravity in m/s^2. | |
| bool | GetUseLocalGravity () const |
| Determines if the local gravity has to be used instead of the world gravity. | |
| void | SetUseLocalGravity (bool useLocalGravity) |
| Sets if the local gravity has to be used instead of the world gravity. | |
| int | GetPointCount () const |
| Retrieves the number of points. | |
| deSmokeDensityPoint * | GetPoints () const |
| Retrieves the pointer to the points which can be NULL. | |
| void | SetPoints (deSmokeDensityPoint *points, int count) |
| Sets the points. | |
| void | NotifyPointsChanged () |
| Notifies the graphic peer that the points changed. | |
System Peers | |
| deBaseGraphicSmokeEmitter * | GetGraphicPeer () const |
| Retrieves the graphic system peer object. | |
| void | SetGraphicPeer (deBaseGraphicSmokeEmitter *peer) |
| Sets the graphic system peer object. | |
| deBasePhysicsSmokeEmitter * | GetPhysicsPeer () const |
| Retrieves the physics system peer object. | |
| void | SetPhysicsPeer (deBasePhysicsSmokeEmitter *peer) |
| Sets the physics system peer object. | |
Detailed Description
Smoke Emitter.
A smoke emitter produces gazous volumetric objects influenced by force fields or other physics objects. The gasous volume is described using a list of density points. Each density point represents a sphere of variable size. The density distribution inside a sphere declines quadratic towards the sphere boundary. The transparency of the sphere depends therefore on the radius. The maximum radius parameter indicates the largest radius of a sphere where the density is not equal to 0. Spheres with a larger radius become invisible and are removed.
- Version:
- 1.0
- Date:
- 2009
Constructor & Destructor Documentation
| deSmokeEmitter::deSmokeEmitter | ( | deSmokeEmitterManager * | manager ) |
Creates a new particle system.
| virtual deSmokeEmitter::~deSmokeEmitter | ( | ) | [virtual] |
Cleans up the particle system.
Member Function Documentation
| bool deSmokeEmitter::CanHit | ( | const decLayerMask & | layerMask, |
| int | groupNumber | ||
| ) | const |
Determines if a particle instance can be hit by another object represented by a layer mask and a group number.
The layer mask and the group number of both entities are checked for a match. Group numbers match only if neither of them is 0.
| int deSmokeEmitter::GetCastTexture | ( | ) | const [inline] |
Retrieves the texture to use from the component skin to cast particles from.
| deComponent* deSmokeEmitter::GetComponent | ( | ) | const [inline] |
Retrieves the component used for casting or NULL.
| const decQuaternion& deSmokeEmitter::GetEmitterOrientation | ( | ) | const [inline] |
Retrieves the emitter orientation.
| const decDVector& deSmokeEmitter::GetEmitterPosition | ( | ) | const [inline] |
Retrieves the emitter position.
| bool deSmokeEmitter::GetEnableCasting | ( | ) | const [inline] |
Determines if casting particles is enabled.
| deBaseGraphicSmokeEmitter* deSmokeEmitter::GetGraphicPeer | ( | ) | const [inline] |
Retrieves the graphic system peer object.
| const decVector& deSmokeEmitter::GetGravity | ( | ) | const [inline] |
Retrieves the gravity in m/s^2.
| int deSmokeEmitter::GetGroupNumber | ( | ) | const [inline] |
Retrieves the group number or 0 if not set.
| decLayerMask& deSmokeEmitter::GetLayerMask | ( | ) | [inline] |
Retrieves the layer mask.
| float deSmokeEmitter::GetMaxCastDensity | ( | ) | const [inline] |
Retrieves the maximum cast density.
| const decVector& deSmokeEmitter::GetMaxCastDirection | ( | ) | const [inline] |
Retrieves the maximum cast direction deviation.
| float deSmokeEmitter::GetMaxCastVelocity | ( | ) | const [inline] |
Retrieves the maximum cast velocity.
| float deSmokeEmitter::GetMinCastDensity | ( | ) | const [inline] |
Retrieves the minimum cast density.
| const decVector& deSmokeEmitter::GetMinCastDirection | ( | ) | const [inline] |
Retrieves the minimum cast direction deviation.
| float deSmokeEmitter::GetMinCastVelocity | ( | ) | const [inline] |
Retrieves the minimum cast velocity.
| deBasePhysicsSmokeEmitter* deSmokeEmitter::GetPhysicsPeer | ( | ) | const [inline] |
Retrieves the physics system peer object.
| int deSmokeEmitter::GetPointCount | ( | ) | const [inline] |
Retrieves the number of points.
| deSmokeDensityPoint* deSmokeEmitter::GetPoints | ( | ) | const [inline] |
Retrieves the pointer to the points which can be NULL.
| deSkin* deSmokeEmitter::GetSkin | ( | ) | const [inline] |
Retrieves the skin of the particle instances or NULL.
| bool deSmokeEmitter::GetUseLocalGravity | ( | ) | const [inline] |
Determines if the local gravity has to be used instead of the world gravity.
| const decDVector& deSmokeEmitter::GetVolumePosition | ( | ) | const [inline] |
Retrieves the volume position.
| void deSmokeEmitter::NotifyLayerMaskChanged | ( | ) |
Notifies the peers that the layer mask changed.
| void deSmokeEmitter::NotifyPointsChanged | ( | ) |
Notifies the graphic peer that the points changed.
| void deSmokeEmitter::SetCastTexture | ( | int | texture ) |
Sets the texture to use from the component skin to cast particles from.
| void deSmokeEmitter::SetComponent | ( | deComponent * | component ) |
Sets the component used for casting or NULL.
| void deSmokeEmitter::SetEmitterOrientation | ( | const decQuaternion & | orientation ) |
Sets the emitter orientation.
| void deSmokeEmitter::SetEmitterPosition | ( | const decDVector & | position ) |
Sets the emitter position.
| void deSmokeEmitter::SetEnableCasting | ( | bool | enable ) |
Sets if casting particles is enabled.
| void deSmokeEmitter::SetGraphicPeer | ( | deBaseGraphicSmokeEmitter * | peer ) |
Sets the graphic system peer object.
| void deSmokeEmitter::SetGravity | ( | const decVector & | gravity ) |
Sets the gravity in m/s^2.
| void deSmokeEmitter::SetGroupNumber | ( | int | groupNumber ) |
Sets the group number or 0 if not set.
| void deSmokeEmitter::SetMaxCastDensity | ( | float | density ) |
Sets the maximum cast density.
| void deSmokeEmitter::SetMaxCastDirection | ( | const decVector & | deviation ) |
Sets the maximum cast direction deviation.
| void deSmokeEmitter::SetMaxCastVelocity | ( | float | velocity ) |
Sets the maximum cast velocity.
| void deSmokeEmitter::SetMinCastDensity | ( | float | density ) |
Sets the minimum cast density.
| void deSmokeEmitter::SetMinCastDirection | ( | const decVector & | deviation ) |
Sets the minimum cast direction deviation.
| void deSmokeEmitter::SetMinCastVelocity | ( | float | velocity ) |
Sets the minimum cast velocity.
| void deSmokeEmitter::SetPhysicsPeer | ( | deBasePhysicsSmokeEmitter * | peer ) |
Sets the physics system peer object.
| void deSmokeEmitter::SetPoints | ( | deSmokeDensityPoint * | points, |
| int | count | ||
| ) |
Sets the points.
| void deSmokeEmitter::SetSkin | ( | deSkin * | skin ) |
Sets the mode of the particle instances or NULL.
| void deSmokeEmitter::SetUseLocalGravity | ( | bool | useLocalGravity ) |
Sets if the local gravity has to be used instead of the world gravity.
| void deSmokeEmitter::SetVolumePosition | ( | const decDVector & | position ) |
Sets the volume position.
The documentation for this class was generated from the following file:
