Packageorg.flintparticles.threeD.actions
Classpublic class ApproachNeighbours
InheritanceApproachNeighbours Inheritance ActionBase Inheritance Object

The ApproachNeighbours action applies an acceleration to the particle to draw it towards other nearby particles. The size of the acceleration is constant, only the direction varies.

This action has a priority of 10, so that it executes before other actions.



Public Properties
 PropertyDefined By
  acceleration : Number
The acceleration force applied to approach the other particles.
ApproachNeighbours
  maxDistance : Number
The maximum distance, in pixels, over which this action operates.
ApproachNeighbours
 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
  
ApproachNeighbours(maxDistance:Number = 0, acceleration:Number = 0)
The constructor creates a ApproachNeighbours action for use by an emitter.
ApproachNeighbours
  
addedToEmitter(emitter:Emitter):void
[override] This method does nothing.
ApproachNeighbours
 Inherited
This method does nothing.
ActionBase
  
update(emitter:Emitter, particle:Particle, time:Number):void
[override] Causes the particle to check all nearby particles and move towards their average position.
ApproachNeighbours
Property Detail
accelerationproperty
acceleration:Number

The acceleration force applied to approach the other particles.


Implementation
    public function get acceleration():Number
    public function set acceleration(value:Number):void
maxDistanceproperty 
maxDistance:Number

The maximum distance, in pixels, over which this action operates. Particles further away than this distance are ignored.


Implementation
    public function get maxDistance():Number
    public function set maxDistance(value:Number):void
Constructor Detail
ApproachNeighbours()Constructor
public function ApproachNeighbours(maxDistance:Number = 0, acceleration:Number = 0)

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

Parameters
maxDistance:Number (default = 0) — The maximum distance, in pixels, over which this action operates. Particles further away than this distance are ignored.
 
acceleration:Number (default = 0) — The acceleration force applied to approach the other particles.

See also

Method Detail
addedToEmitter()method
override public 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.

update()method 
override public function update(emitter:Emitter, particle:Particle, time:Number):void

Causes the particle to check all nearby particles and move towards their average position.

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