CrystalSpace

Public API Reference

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

iParticlesObjectState Struct Reference
[3D]

Particles state object. More...

#include <particles.h>

Inheritance diagram for iParticlesObjectState:

iBase List of all members.

Public Methods

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 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 GetEmitPosition (csVector3 &position)=0
 Get emitter position.

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 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 (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 AddColor (csColor color)=0
 Add a color to the gradient.

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

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 csParticleColorMethod GetParticleColorMethod ()=0
 Get the particle color method.

virtual csColor GetConstantColor ()=0
 Get the constant color (for constant color method).

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 particle 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 csReversibleTransform GetObjectToCamera ()=0
 Get the camera transform.

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

virtual void Start ()=0
 (Re)Start the particle emitter.

virtual void Stop ()=0
 Stop this particle object from emitting any more particles.

virtual bool IsRunning ()=0
 Returns true if this particle simulation is running.


Detailed Description

Particles state object.

Definition at line 110 of file particles.h.


Member Function Documentation

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

Add a color to the gradient.

virtual void iParticlesObjectState::ChangePhysicsPlugin const char *    plugin [pure virtual]
 

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

virtual void iParticlesObjectState::ClearColors   [pure virtual]
 

Clear the color gradient.

virtual float iParticlesObjectState::GetBaseHeat   [pure virtual]
 

Get the base heat (for heat color method).

virtual iParticlesColorCallback* iParticlesObjectState::GetColorCallback   [pure virtual]
 

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

virtual float iParticlesObjectState::GetColorLoopTime   [pure virtual]
 

Get the loop time (for looping color method).

virtual csColor iParticlesObjectState::GetConstantColor   [pure virtual]
 

Get the constant color (for constant color method).

virtual float iParticlesObjectState::GetDampener   [pure virtual]
 

Set the dampener (air viscosity).

virtual float iParticlesObjectState::GetDiffusion   [pure virtual]
 

Get the diffusion amount.

virtual void iParticlesObjectState::GetEmitPosition csVector3   position [pure virtual]
 

Get emitter position.

virtual float iParticlesObjectState::GetEmitTime   [pure virtual]
 

Get emit time.

virtual csParticleEmitType iParticlesObjectState::GetEmitType   [pure virtual]
 

Get the emitter type.

virtual float iParticlesObjectState::GetEmitXSize   [pure virtual]
 

Get the X size for a plane or box emitter.

virtual float iParticlesObjectState::GetEmitYSize   [pure virtual]
 

Get the Y size for a plane or box emitter.

virtual float iParticlesObjectState::GetEmitZSize   [pure virtual]
 

Get the Z size for a plane or box emitter.

virtual void iParticlesObjectState::GetFalloffType csParticleFalloffType   force,
csParticleFalloffType   cone
[pure virtual]
 

Get the force falloff types.

virtual float iParticlesObjectState::GetForce   [pure virtual]
 

Get the force amount.

virtual float iParticlesObjectState::GetForceConeRadius   [pure virtual]
 

Get the force cone radius.

virtual void iParticlesObjectState::GetForceDirection csVector3   dir [pure virtual]
 

Get the force direction.

virtual float iParticlesObjectState::GetForceRange   [pure virtual]
 

Get force range.

virtual csParticleForceType iParticlesObjectState::GetForceType   [pure virtual]
 

Get the force type.

virtual void iParticlesObjectState::GetGravity csVector3   gravity [pure virtual]
 

Get the gravity vector.

virtual int iParticlesObjectState::GetInitialParticleCount   [pure virtual]
 

Get the initial particle burst count.

virtual float iParticlesObjectState::GetMass   [pure virtual]
 

Get the particle mass.

virtual float iParticlesObjectState::GetMassVariation   [pure virtual]
 

Get the random variation in particle mass.

virtual csReversibleTransform iParticlesObjectState::GetObjectToCamera   [pure virtual]
 

Get the camera transform.

virtual csParticleColorMethod iParticlesObjectState::GetParticleColorMethod   [pure virtual]
 

Get the particle color method.

virtual float iParticlesObjectState::GetParticleRadius   [pure virtual]
 

Get the particle radius.

virtual int iParticlesObjectState::GetParticlesPerSecond   [pure virtual]
 

Get the particles emitted per second count.

virtual float iParticlesObjectState::GetSphereEmitInnerRadius   [pure virtual]
 

Get the inner radius for a sphere emitter.

virtual float iParticlesObjectState::GetSphereEmitOuterRadius   [pure virtual]
 

Get the outer radius for a sphere emitter.

virtual float iParticlesObjectState::GetTimeToLive   [pure virtual]
 

Get time to live.

virtual float iParticlesObjectState::GetTimeVariation   [pure virtual]
 

Get the time variation.

virtual bool iParticlesObjectState::IsRunning   [pure virtual]
 

Returns true if this particle simulation is running.

virtual void iParticlesObjectState::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 iParticlesObjectState::SetColorCallback iParticlesColorCallback   [pure virtual]
 

Set the color method to use a callback.

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

Set a cone force type.

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

Set the color method to a constant color.

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

Set the dampener (air viscosity).

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

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

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

How many seconds the emitter will be emitting.

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

Set the force amount.

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

Set the gravity vector to effect this particle set.

virtual void iParticlesObjectState::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 iParticlesObjectState::SetInitialParticleCount int    count [pure virtual]
 

Set the initial particle burst count.

virtual void iParticlesObjectState::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 iParticlesObjectState::SetLinearForceType csVector3   direction,
float    range,
csParticleFalloffType    falloff
[pure virtual]
 

Set a linear force type.

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

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

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

Set the individual particle mass.

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

Set the random variation in particle mass.

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

Set the particle radius.

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

Sets the particles to be emitted per second.

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

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

virtual void iParticlesObjectState::SetPointEmitType   [pure virtual]
 

Set the emitter type to a point.

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

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

virtual void iParticlesObjectState::SetSphereEmitType float    outer_radius,
float    inner_radius
[pure virtual]
 

Set the emitter type to a sphere (which can have an inner radius).

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

The time that each particle exists, in seconds.

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

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

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

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

virtual void iParticlesObjectState::Start   [pure virtual]
 

(Re)Start the particle emitter.

This is automatically called when the particle mesh object is created if autostart is enabled (default:yes)

virtual void iParticlesObjectState::Stop   [pure virtual]
 

Stop this particle object from emitting any more particles.


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