| Package | org.flintparticles.common.actions |
| Class | public class ChangeCollisionRadius |
| Inheritance | ChangeCollisionRadius ActionBase Object |
Usually a particle's energy changes from 1 to 0 over its lifetime, but this can be altered via the easing function set within the age action.
This action should be used in conjunction with the Age action.
See also
| Property | Defined By | ||
|---|---|---|---|
| endRadius : Number
The collision radius for the particle when its energy
is 0 - usually at the end of its lifetime. | ChangeCollisionRadius | ||
![]() | priority : int
Returns a default priority of 0 for this action. | ActionBase | |
| startRadius : Number
The collision radius for the particle when its energy
is 1 - usually at the start of its lifetime. | ChangeCollisionRadius | ||
| Method | Defined By | ||
|---|---|---|---|
ChangeCollisionRadius(startRadius:Number = 1, endRadius:Number = 1)
The constructor creates a ChangeCollisionRadius action for use by an emitter. | ChangeCollisionRadius | ||
![]() | addedToEmitter(emitter:Emitter):void
This method does nothing. | ActionBase | |
![]() | removedFromEmitter(emitter:Emitter):void
This method does nothing. | ActionBase | |
[override]
Sets the collision radius of the particle based on the values defined
and the particle's energy level. | ChangeCollisionRadius | ||
| endRadius | property |
endRadius:NumberThe collision radius for the particle when its energy is 0 - usually at the end of its lifetime.
public function get endRadius():Number public function set endRadius(value:Number):void| startRadius | property |
startRadius:NumberThe collision radius for the particle when its energy is 1 - usually at the start of its lifetime.
public function get startRadius():Number public function set startRadius(value:Number):void| ChangeCollisionRadius | () | Constructor |
public function ChangeCollisionRadius(startRadius:Number = 1, endRadius:Number = 1)The constructor creates a ChangeCollisionRadius action for use by an emitter. To add a Radius to all particles created by an emitter, use the emitter's addAction method.
ParametersstartRadius:Number (default = 1) — The collision radius for the particle when its energy
is 1 - usually at the start of its lifetime.
| |
endRadius:Number (default = 1) — The collision radius for the particle when its energy
is 0 - usually at the end of its lifetime.
|
See also
| update | () | method |
override public function update(emitter:Emitter, particle:Particle, time:Number):voidSets the collision radius of the particle based on the values defined and the particle's energy level.
This method is called by the emitter and need not be called by the user
Parameters
emitter:Emitter — The Emitter that created the particle.
| |
particle:Particle — The particle to be updated.
| |
time:Number — The duration of the frame - used for time based updates.
|
See also