Packageorg.flintparticles.threeD.actions
Classpublic class SpeedLimit
InheritanceSpeedLimit Inheritance ActionBase Inheritance Object

The SpeedLimit action limits the particle's maximum speed to the specified speed. The behaviour can be switched to instead limit the minimum speed to the specified speed.

This action has aa priority of -5, so that it executes after all accelerations have occured.


Public Properties
 PropertyDefined By
  isMinimum : Boolean
Whether the speed is a minimum (true) or maximum (false) speed.
SpeedLimit
  limit : Number
The speed limit
SpeedLimit
 Inheritedpriority : int
Returns a default priority of 0 for this action.
ActionBase
Protected Properties
 PropertyDefined By
 Inherited_priority : int = 0
ActionBase
Public Methods
 MethodDefined By
  
SpeedLimit(speed:Number, isMinimum:Boolean = false)
The constructor creates a SpeedLimit action for use by an emitter.
SpeedLimit
 Inherited
addedToEmitter(emitter:Emitter):void
This method does nothing.
ActionBase
 Inherited
removedFromEmitter(emitter:Emitter):void
This method does nothing.
ActionBase
  
update(emitter:Emitter, particle:Particle, time:Number):void
[override] This method does nothing.
SpeedLimit
Property Detail
isMinimumproperty
isMinimum:Boolean

Whether the speed is a minimum (true) or maximum (false) speed.


Implementation
    public function get isMinimum():Boolean
    public function set isMinimum(value:Boolean):void
limitproperty 
limit:Number

The speed limit


Implementation
    public function get limit():Number
    public function set limit(value:Number):void
Constructor Detail
SpeedLimit()Constructor
public function SpeedLimit(speed:Number, isMinimum:Boolean = false)

The constructor creates a SpeedLimit action for use by an emitter. To add a SpeedLimit to all particles created by an emitter, use the emitter's addAction method.

Parameters
speed:Number (default = NaN) — The speed limit for the action in pixels per second.
 
isMinimum:Boolean (default = false) — If true, particles travelling slower than the speed limit are accelerated to the speed limit, otherwise particles travelling faster than the speed limit are decelerated to the speed limit.

See also

org.flintparticles.common.emitters.Emitter.addAction()
Method Detail
update()method
override public function update(emitter:Emitter, particle:Particle, time:Number):void

This method does nothing. All derived classes override this method to update each particle every frame.

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.




© Richard Lord 2008-2011

Sun Feb 27 2011, 06:00 PM Z