CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iParticlesFactoryState Struct Reference
[3D]

Particles factory state. More...

#include <particles.h>

Inheritance diagram for iParticlesFactoryState:

iBase List of all members.

Public Methods

virtual void SetMaterial (iMaterialWrapper *material)=0
 Set the material to use for this particle factory.

virtual void SetParticlesPerSecond (int count)=0
 Sets the particles to be emitted per second.

virtual void SetInitialParticleCount (int count)=0
 Set the initial particle burst count.

virtual void SetPointEmitType ()=0
 Set the emitter type to a point.

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 SetRadialForceType (float range, csParticleFalloffType)=0
 Set a radial force type, with range and falloff type.

virtual void SetLinearForceType (csVector3 &direction, float range, csParticleFalloffType falloff)=0
 Set a linear force type.

virtual void SetConeForceType (csVector3 &direction, float range, csParticleFalloffType falloff, float radius, csParticleFalloffType radius_falloff)=0
 Set a cone force type.

virtual void SetForce (float force)=0
 Set the force amount.

virtual void SetDiffusion (float size)=0
 Set the diffusion amount (random walk) in CS units per second.

virtual void SetGravity (csVector3 &gravity)=0
 Set the gravity vector to effect this particle set.

virtual void SetEmitTime (float time)=0
 How many seconds the emitter will be emitting.

virtual void SetTimeToLive (float time)=0
 The time that each particle exists, in seconds.

virtual void SetTimeVariation (float variation)=0
 Set the random variation in particle time to live, in seconds.

virtual void SetConstantColorMethod (csColor 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 iParticlesColorCallbackGetColorCallback ()=0
 Get the color callback. Returns null if no callback has been set.

virtual void AddColor (csColor color)=0
 Add a color to the gradient.

virtual void ClearColors ()=0
 Clear the color gradient.

virtual void SetParticleRadius (float radius)=0
 Set the point 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 SetAutoStart (bool autostart)=0
 Set whether the emitter automatically starts (default: true).

virtual void SetTransformMode (bool transform)=0
 Set whether to apply the mesh's transform to the individual particles.

virtual void SetPhysicsPlugin (const char *plugin)=0
 Set the particle physics plugin (Defaults to 'crystalspace.particles.physics.simple').


Detailed Description

Particles factory state.

Definition at line 324 of file particles.h.


Member Function Documentation

virtual void iParticlesFactoryState::AddColor csColor    color [pure virtual]
 

Add a color to the gradient.

virtual void iParticlesFactoryState::ClearColors   [pure virtual]
 

Clear the color gradient.

virtual iParticlesColorCallback* iParticlesFactoryState::GetColorCallback   [pure virtual]
 

Get the color callback. Returns null if no callback has been set.

virtual float iParticlesFactoryState::GetDampener   [pure virtual]
 

Set the dampener (air viscosity).

virtual float iParticlesFactoryState::GetMass   [pure virtual]
 

Get the particle mass.

virtual float iParticlesFactoryState::GetMassVariation   [pure virtual]
 

Get the random variation in particle mass.

virtual void iParticlesFactoryState::SetAutoStart bool    autostart [pure virtual]
 

Set whether the emitter automatically starts (default: true).

virtual void iParticlesFactoryState::SetBoxEmitType float    x_size,
float    y_size,
float    z_size
[pure virtual]
 

Set the emitter type to a box (which can be rotated).

virtual void iParticlesFactoryState::SetColorCallback iParticlesColorCallback   [pure virtual]
 

Set the color method to use a callback.

virtual void iParticlesFactoryState::SetConeForceType csVector3   direction,
float    range,
csParticleFalloffType    falloff,
float    radius,
csParticleFalloffType    radius_falloff
[pure virtual]
 

Set a cone force type.

virtual void iParticlesFactoryState::SetConstantColorMethod csColor    color [pure virtual]
 

Set the color method to a constant color.

virtual void iParticlesFactoryState::SetDampener float    damp [pure virtual]
 

Set the dampener (air viscosity).

virtual void iParticlesFactoryState::SetDiffusion float    size [pure virtual]
 

Set the diffusion amount (random walk) in CS units per second.

virtual void iParticlesFactoryState::SetEmitTime float    time [pure virtual]
 

How many seconds the emitter will be emitting.

virtual void iParticlesFactoryState::SetForce float    force [pure virtual]
 

Set the force amount.

virtual void iParticlesFactoryState::SetGravity csVector3   gravity [pure virtual]
 

Set the gravity vector to effect this particle set.

virtual void iParticlesFactoryState::SetHeatColorMethod int    base_temp [pure virtual]
 

Set the color method to use heat (calculated by the physics plugin).

Parameters:
base_temp  The temperature in degrees C at the emitter

virtual void iParticlesFactoryState::SetInitialParticleCount int    count [pure virtual]
 

Set the initial particle burst count.

virtual void iParticlesFactoryState::SetLinearColorMethod   [pure virtual]
 

Set the color method to linear color (based on time to live using the gradient (specified above using ClearColors() and AddColor() ).

virtual void iParticlesFactoryState::SetLinearForceType csVector3   direction,
float    range,
csParticleFalloffType    falloff
[pure virtual]
 

Set a linear force type.

virtual void iParticlesFactoryState::SetLoopingColorMethod float    seconds [pure virtual]
 

Set the color method to looping color (loops forever, cycling once per seconds specified).

virtual void iParticlesFactoryState::SetMass float    mass [pure virtual]
 

Set the individual particle mass.

virtual void iParticlesFactoryState::SetMassVariation float    variation [pure virtual]
 

Set the random variation in particle mass.

virtual void iParticlesFactoryState::SetMaterial iMaterialWrapper   material [pure virtual]
 

Set the material to use for this particle factory.

virtual void iParticlesFactoryState::SetParticleRadius float    radius [pure virtual]
 

Set the point radius.

virtual void iParticlesFactoryState::SetParticlesPerSecond int    count [pure virtual]
 

Sets the particles to be emitted per second.

virtual void iParticlesFactoryState::SetPhysicsPlugin const char *    plugin [pure virtual]
 

Set the particle physics plugin (Defaults to 'crystalspace.particles.physics.simple').

virtual void iParticlesFactoryState::SetPlaneEmitType float    x_size,
float    y_size
[pure virtual]
 

Set the emitter type to a plane (which can be rotated).

virtual void iParticlesFactoryState::SetPointEmitType   [pure virtual]
 

Set the emitter type to a point.

virtual void iParticlesFactoryState::SetRadialForceType float    range,
csParticleFalloffType   
[pure virtual]
 

Set a radial force type, with range and falloff type.

virtual void iParticlesFactoryState::SetTimeToLive float    time [pure virtual]
 

The time that each particle exists, in seconds.

virtual void iParticlesFactoryState::SetTimeVariation float    variation [pure virtual]
 

Set the random variation in particle time to live, in seconds.

virtual void iParticlesFactoryState::SetTransformMode bool    transform [pure virtual]
 

Set whether to apply the mesh's transform to the individual particles.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18