ExplosionParams Class Reference
Explosion parameters, used for instantiation of Explosion class. More...
#include <Explosion.h>
Public Types | |
| enum | ERenderMode { RENDER_SPRITE, RENDER_BILLBOARD, RENDER_BILLBOARD_DEPTH_ALWAYS } |
Public Member Functions | |
| ExplosionParams () | |
Public Attributes | |
| ERenderMode | renderMode |
| float | maxRadius |
| Full-size radius. | |
| float | growingSpeed |
| Units per seconds for radius to grow, or 0 for inifnite speed. | |
| float | maxForce |
| Force applied on touched objects (can be 0). | |
| float | colorAttenuationPow |
| Attenuation of the alpha will be raised by this factor. | |
| osg::Vec4f | diffuseColor |
| Diffuse color of the 3D sphere at the begining (alpha indicates the whole transparency, regardless of the alpha of emissionColor). You may use values greater than 1 (for RGB components) if needed. | |
| osg::Vec4f | emissionColor |
| Emissive color of the 3D sphere at the begining (alpha has no effect). | |
| osg::Vec4f | lightDiffuse |
| Diffuse color for the light at the begining. | |
| float | lightLinearAttenuation |
| Linear attenuation of the light source (quadratic is not supported yet). | |
| osg::StateSet * | pLightStateSet |
| State set of the node under which children will be affected by the light. If NULL, no lightning will be acheived. | |
| UINT | lightNumber |
| Can be set to any number allowed by OpenGL (in [0;7] actually), or any value if a LightSourceManager (pLSM pointer) is provided (ie. the number is ignored). | |
| LightSourceManager * | pLSM |
| LightSourceManager to be used, or NULL. | |
| LightSourceManager::Priority | lightBasePriority |
| Base priority to be used on construction with LightSourceManager when pLSM != NULL. Priority decreases over time, as the explosion generates less light. | |
| osg::Vec4f | spriteEmission |
| Emissive color of the sprite. | |
Detailed Description
Explosion parameters, used for instantiation of Explosion class.
- Todo:
- create a second class for 'discardable' parameters (those used in the constructor only), to save memory.
Definition at line 49 of file Explosion.h.
Member Enumeration Documentation
- Enumerator:
-
RENDER_SPRITE Uses standard sprite. RENDER_BILLBOARD Uses a billboard. RENDER_BILLBOARD_DEPTH_ALWAYS Uses a billboard and osg::Depth(osg::Depth::ALWAYS).
Definition at line 52 of file Explosion.h.
Constructor & Destructor Documentation
| ExplosionParams::ExplosionParams | ( | ) |
Definition at line 52 of file Explosion.cpp.
Member Data Documentation
Attenuation of the alpha will be raised by this factor.
Definition at line 66 of file Explosion.h.
Referenced by Explosion::hitBefore(), and Explosion::step().
| osg::Vec4f ExplosionParams::diffuseColor |
Diffuse color of the 3D sphere at the begining (alpha indicates the whole transparency, regardless of the alpha of emissionColor). You may use values greater than 1 (for RGB components) if needed.
Definition at line 67 of file Explosion.h.
Referenced by Explosion::step().
| osg::Vec4f ExplosionParams::emissionColor |
Emissive color of the 3D sphere at the begining (alpha has no effect).
Definition at line 68 of file Explosion.h.
Referenced by Explosion::step().
Units per seconds for radius to grow, or 0 for inifnite speed.
Definition at line 60 of file Explosion.h.
Referenced by Explosion::init(), and Explosion::step().
Base priority to be used on construction with LightSourceManager when pLSM != NULL. Priority decreases over time, as the explosion generates less light.
Definition at line 79 of file Explosion.h.
Referenced by Explosion::init(), and Explosion::step().
| osg::Vec4f ExplosionParams::lightDiffuse |
Diffuse color for the light at the begining.
Definition at line 70 of file Explosion.h.
Referenced by Explosion::createLight(), and Explosion::step().
Linear attenuation of the light source (quadratic is not supported yet).
Definition at line 71 of file Explosion.h.
Referenced by Explosion::createLight().
Can be set to any number allowed by OpenGL (in [0;7] actually), or any value if a LightSourceManager (pLSM pointer) is provided (ie. the number is ignored).
Definition at line 77 of file Explosion.h.
Referenced by Explosion::init().
Force applied on touched objects (can be 0).
Definition at line 62 of file Explosion.h.
Referenced by Explosion::hitBefore(), Explosion::init(), and Explosion::step().
Full-size radius.
Definition at line 59 of file Explosion.h.
Referenced by Explosion::hitBefore(), Explosion::init(), and Explosion::step().
| osg::StateSet* ExplosionParams::pLightStateSet |
State set of the node under which children will be affected by the light. If NULL, no lightning will be acheived.
Definition at line 72 of file Explosion.h.
Referenced by Explosion::createLight(), Explosion::init(), Explosion::LSCallback::onSourceTaken(), Explosion::step(), and Explosion::~Explosion().
LightSourceManager to be used, or NULL.
Definition at line 78 of file Explosion.h.
Referenced by Explosion::init(), Explosion::LSCallback::onUserDropped(), Explosion::step(), and Explosion::~Explosion().
| osg::Vec4f ExplosionParams::spriteEmission |
Emissive color of the sprite.
Definition at line 80 of file Explosion.h.
Referenced by Explosion::init().
The documentation for this class was generated from the following files:
