Packageorg.flintparticles.threeD.actions
Classpublic class ZonedAction
InheritanceZonedAction Inheritance ActionBase

The ZonedAction Action applies an action to the particle only if it is in the specified zone.



Public Properties
 PropertyDefined by
  action : Action
The action to apply when inside the zone.
ZonedAction
  invertZone : Boolean
If false (the default), the action is applied to particles inside the zone.
ZonedAction
  zone : Zone3D
The zone in which to apply the acceleration.
ZonedAction
Public Methods
 MethodDefined by
  
ZonedAction(action:Action, zone:Zone3D, invertZone:Boolean = false)
The constructor creates a ZonedAction action for use by an emitter.
ZonedAction
  
addedToEmitter(emitter:Emitter):void
This method does nothing.
ZonedAction
  
Returns a default priority of 0 for this action.
ZonedAction
  
This method does nothing.
ZonedAction
  
update(emitter:Emitter, particle:Particle, time:Number):void
This method does nothing.
ZonedAction
Property detail
actionproperty
action:Action  [read-write]

The action to apply when inside the zone.

Implementation
    public function get action():Action
    public function set action(value:Action):void
invertZoneproperty 
invertZone:Boolean  [read-write]

If false (the default), the action is applied to particles inside the zone. If true, the action is applied to particles outside the zone.

Implementation
    public function get invertZone():Boolean
    public function set invertZone(value:Boolean):void
zoneproperty 
zone:Zone3D  [read-write]

The zone in which to apply the acceleration.

Implementation
    public function get zone():Zone3D
    public function set zone(value:Zone3D):void
Constructor detail
ZonedAction()constructor
public function ZonedAction(action:Action, zone:Zone3D, invertZone:Boolean = false)

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

Parameters
action:Action — The action to apply when inside the zone.
 
zone:Zone3D — The zone in which to apply the action.
 
invertZone:Boolean (default = false) — If false (the default) the action is applied only to particles inside the zone. If true the action is applied only to particles outside the zone.

See also

org.flintparticles.emitters.Emitter.addAction()
Method detail
addedToEmitter()method
public override function addedToEmitter(emitter:Emitter):void

This method does nothing. Some derived classes override this method to perform actions when the action is added to an emitter.

Parameters
emitter:Emitter — The Emitter that the Action was added to.
getDefaultPriority()method 
public override function getDefaultPriority():Number

Returns a default priority of 0 for this action. Derived classes override this method if they want a different default priority.

Returns
Number
removedFromEmitter()method 
public override function removedFromEmitter(emitter:Emitter):void

This method does nothing. Some derived classes override this method to perform actions when the action is removed from the emitter.

Parameters
emitter:Emitter — The Emitter that the Action was removed from.
update()method 
public override 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.