| Package | org.flintparticles.twoD.actions |
| Class | public class ApproachNeighbours |
| Inheritance | ApproachNeighbours  ActionBase Object |
ApproachNeighbours is most commonly used when creating flocking behaviours. Flocking is usually a combination of ApproachNeighbours to draw particles together, MinimumDistance to stop them getting too close and MatchVelocity to make them match speed and direction of motion.
This action has a priority of 10, so that it executes before other actions.
See also
| Property | Defined By | ||
|---|---|---|---|
| acceleration : Number
The acceleration applied to approach the other particles. | ApproachNeighbours | ||
| maxDistance : Number
The maximum distance, in pixels, over which this action operates. | ApproachNeighbours | ||
 | priority : int
Returns a default priority of 0 for this action. | ActionBase | |
| Method | Defined By | ||
|---|---|---|---|
ApproachNeighbours(maxDistance:Number = 0, acceleration:Number = 0)
The constructor creates an ApproachNeighbours action for use by an emitter. | ApproachNeighbours | ||
addedToEmitter(emitter:Emitter):void [override]
Instructs the emitter to produce a sorted particle array for optimizing
the calculations in the update method of this action. | ApproachNeighbours | ||
| removedFromEmitter(emitter:Emitter):void
This method does nothing. | ActionBase | |
[override]
Checks all particles near the current particle and applies the
acceleration to move the particle towards their average position. | ApproachNeighbours | ||
| acceleration | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesacceleration:NumberThe acceleration applied to approach the other particles.
public function get acceleration():Number public function set acceleration(value:Number):void| maxDistance | property |
maxDistance:NumberThe maximum distance, in pixels, over which this action operates. Particles further apart than this distance ignore each other.
public function get maxDistance():Number public function set maxDistance(value:Number):void| ApproachNeighbours | () | Constructor |
public function ApproachNeighbours(maxDistance:Number = 0, acceleration:Number = 0)The constructor creates an ApproachNeighbours action for use by an emitter. To add an ApproachNeighbours to all particles created by an emitter, use the emitter's addAction method.
ParametersmaxDistance:Number (default = 0) | |
acceleration:Number (default = 0) |
See also
| addedToEmitter | () | method |
override public function addedToEmitter(emitter:Emitter):voidInstructs the emitter to produce a sorted particle array for optimizing the calculations in the update method of this action.
Parameters
emitter:Emitter — The emitter this action has been added to.
|
See also
| update | () | method |
override public function update(emitter:Emitter, particle:Particle, time:Number):voidChecks all particles near the current particle and applies the acceleration to move the particle 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