iParticlesStateBase Struct Reference
[3D]
Particles shared state interface.
More...
#include <imesh/particles.h>
Inheritance diagram for iParticlesStateBase:

Public Member Functions | |
virtual void | SetParticlesPerSecond (int count)=0 |
Sets the particles to be emitted per second. | |
virtual int | GetParticlesPerSecond ()=0 |
Get the particles emitted per second count. | |
virtual void | SetInitialParticleCount (int count)=0 |
Set the initial particle burst count. | |
virtual int | GetInitialParticleCount ()=0 |
Get the initial particle burst count. | |
virtual void | SetPointEmitType ()=0 |
Set the emitter type to a point. | |
virtual void | SetSphereEmitType (float outer_radius, float inner_radius)=0 |
Set the emitter type to a sphere (which can have an inner radius). | |
virtual void | SetPlaneEmitType (float x_size, float y_size)=0 |
Set the emitter type to a plane (which can be rotated). | |
virtual void | SetBoxEmitType (float x_size, float y_size, float z_size)=0 |
Set the emitter type to a box (which can be rotated). | |
virtual void | SetCylinderEmitType (float radius, float height)=0 |
Set the emitter type to a cylinder (which can be rotated). | |
virtual float | GetSphereEmitInnerRadius ()=0 |
Get the inner radius for a sphere emitter. | |
virtual float | GetSphereEmitOuterRadius ()=0 |
Get the outer radius for a sphere emitter. | |
virtual float | GetEmitXSize ()=0 |
Get the X size for a plane or box emitter. | |
virtual float | GetEmitYSize ()=0 |
Get the Y size for a plane or box emitter. | |
virtual float | GetEmitZSize ()=0 |
Get the Z size for a plane or box emitter. | |
virtual csParticleEmitType | GetEmitType ()=0 |
Get the emitter type. | |
virtual void | SetRadialForceType (float range, csParticleFalloffType)=0 |
Set a radial force type, with range and falloff type. | |
virtual void | SetLinearForceType (const csVector3 &direction, float range, csParticleFalloffType falloff)=0 |
Set a linear force type. | |
virtual void | SetConeForceType (const csVector3 &direction, float range, csParticleFalloffType falloff, float radius, csParticleFalloffType radius_falloff)=0 |
Set a cone force type. | |
virtual csParticleForceType | GetForceType ()=0 |
Get the force type. | |
virtual float | GetForceRange ()=0 |
Get force range. | |
virtual void | GetFalloffType (csParticleFalloffType &force, csParticleFalloffType &cone)=0 |
Get the force falloff types. | |
virtual void | GetForceDirection (csVector3 &dir)=0 |
Get the force direction. | |
virtual float | GetForceConeRadius ()=0 |
Get the force cone radius. | |
virtual void | SetForce (float force)=0 |
Set the force amount. | |
virtual float | GetForce ()=0 |
Get the force amount. | |
virtual void | SetDiffusion (float size)=0 |
Set the diffusion amount (random walk) in CS units per second. | |
virtual float | GetDiffusion ()=0 |
Get the diffusion amount. | |
virtual void | SetGravity (const csVector3 &gravity)=0 |
Set the gravity vector to effect this particle set. | |
virtual void | GetGravity (csVector3 &gravity)=0 |
Get the gravity vector. | |
virtual void | SetEmitTime (float time)=0 |
How many seconds the emitter will be emitting. | |
virtual float | GetEmitTime ()=0 |
Get emit time. | |
virtual void | SetTimeToLive (float time)=0 |
The time that each particle exists, in seconds. | |
virtual float | GetTimeToLive ()=0 |
Get time to live. | |
virtual void | SetTimeVariation (float variation)=0 |
Set the random variation in particle time to live, in seconds. | |
virtual float | GetTimeVariation ()=0 |
Get the time variation. | |
virtual void | SetConstantColorMethod (csColor4 color)=0 |
Set the color method to a constant color. | |
virtual void | SetLinearColorMethod ()=0 |
Set the color method to linear color (based on time to live using the gradient (specified above using ClearColors() and AddColor() ). | |
virtual void | SetLoopingColorMethod (float seconds)=0 |
Set the color method to looping color (loops forever, cycling once per seconds specified). | |
virtual void | SetHeatColorMethod (int base_temp)=0 |
Set the color method to use heat (calculated by the physics plugin). | |
virtual void | SetColorCallback (iParticlesColorCallback *)=0 |
Set the color method to use a callback. | |
virtual iParticlesColorCallback * | GetColorCallback ()=0 |
Get the color callback. Returns null if no callback has been set. | |
virtual void | AddColor (csColor4 color)=0 |
Add a color to the gradient. | |
virtual void | ClearColors ()=0 |
Clear the color gradient. | |
virtual csParticleColorMethod | GetParticleColorMethod ()=0 |
Get the particle color method. | |
virtual void | GetConstantColor (csColor4 &color)=0 |
Get the constant color (for constant color method). | |
virtual const csArray< csColor4 > & | GetGradient ()=0 |
Get the color gradient. | |
virtual float | GetColorLoopTime ()=0 |
Get the loop time (for looping color method). | |
virtual float | GetBaseHeat ()=0 |
Get the base heat (for heat color method). | |
virtual void | SetParticleRadius (float radius)=0 |
Set the point radius. | |
virtual float | GetParticleRadius ()=0 |
Get the particle radius. | |
virtual void | SetDampener (float damp)=0 |
Set the dampener (air viscosity). | |
virtual float | GetDampener ()=0 |
Set the dampener (air viscosity). | |
virtual void | SetMass (float mass)=0 |
Set the individual particle mass. | |
virtual void | SetMassVariation (float variation)=0 |
Set the random variation in particle mass. | |
virtual float | GetMass ()=0 |
Get the particle mass. | |
virtual float | GetMassVariation ()=0 |
Get the random variation in particle mass. | |
virtual void | SetTransformMode (bool transform)=0 |
Set whether to apply the mesh's transform to the individual particles. | |
virtual bool | GetTransformMode ()=0 |
Returns true if this particle object uses transform mode. |
Detailed Description
Particles shared state interface.
Definition at line 111 of file particles.h.
Member Function Documentation
|
Add a color to the gradient.
|
|
Clear the color gradient.
|
|
Get the base heat (for heat color method).
|
|
Get the color callback. Returns null if no callback has been set.
|
|
Get the loop time (for looping color method).
|
|
Get the constant color (for constant color method).
|
|
Set the dampener (air viscosity).
|
|
Get the diffusion amount.
|
|
Get emit time.
|
|
Get the emitter type.
|
|
Get the X size for a plane or box emitter.
|
|
Get the Y size for a plane or box emitter.
|
|
Get the Z size for a plane or box emitter.
|
|
Get the force falloff types.
|
|
Get the force amount.
|
|
Get the force cone radius.
|
|
Get the force direction.
|
|
Get force range.
|
|
Get the force type.
|
|
Get the color gradient.
|
|
Get the gravity vector.
|
|
Get the initial particle burst count.
|
|
Get the particle mass.
|
|
Get the random variation in particle mass.
|
|
Get the particle color method.
|
|
Get the particle radius.
|
|
Get the particles emitted per second count.
|
|
Get the inner radius for a sphere emitter.
|
|
Get the outer radius for a sphere emitter.
|
|
Get time to live.
|
|
Get the time variation.
|
|
Returns true if this particle object uses transform mode.
|
|
Set the emitter type to a box (which can be rotated).
|
|
Set the color method to use a callback.
|
|
Set a cone force type.
|
|
Set the color method to a constant color.
|
|
Set the emitter type to a cylinder (which can be rotated).
|
|
Set the dampener (air viscosity).
|
|
Set the diffusion amount (random walk) in CS units per second.
|
|
How many seconds the emitter will be emitting.
|
|
Set the force amount.
|
|
Set the gravity vector to effect this particle set.
|
|
Set the color method to use heat (calculated by the physics plugin).
|
|
Set the initial particle burst count.
|
|
Set the color method to linear color (based on time to live using the gradient (specified above using ClearColors() and AddColor() ).
|
|
Set a linear force type.
|
|
Set the color method to looping color (loops forever, cycling once per seconds specified).
|
|
Set the individual particle mass.
|
|
Set the random variation in particle mass.
|
|
Set the point radius.
|
|
Sets the particles to be emitted per second.
|
|
Set the emitter type to a plane (which can be rotated).
|
|
Set the emitter type to a point.
|
|
Set a radial force type, with range and falloff type.
|
|
Set the emitter type to a sphere (which can have an inner radius).
|
|
The time that each particle exists, in seconds.
|
|
Set the random variation in particle time to live, in seconds.
|
|
Set whether to apply the mesh's transform to the individual particles.
|
The documentation for this struct was generated from the following file:
- imesh/particles.h
Generated for Crystal Space by doxygen 1.3.9.1