Packageorg.flintparticles.common.actions
Classpublic class ScaleImage
InheritanceScaleImage Inheritance ActionBase Inheritance Object

The ScaleImage action adjusts the size of the particles imnage as it ages. It uses the particle's energy level to decide what size the particle should be.

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.

If you also want to adjust the mass and collision radius of the particle, use the ScaleAll action.

See also

org.flintparticles.twoD.actions.ScaleAll
org.flintparticles.threeD.actions.ScaleAll
org.flintparticles.common.actions.Action
org.flintparticles.common.actions.Age


Public Properties
 PropertyDefined By
  endScale : Number
The scale factor for the particle when its energy is 0 - usually at the end of its lifetime.
ScaleImage
 Inheritedpriority : int
Returns a default priority of 0 for this action.
ActionBase
  startScale : Number
The scale factor for the particle when its energy is 1 - usually at the start of its lifetime.
ScaleImage
Protected Properties
 PropertyDefined By
 Inherited_priority : int = 0
ActionBase
Public Methods
 MethodDefined By
  
ScaleImage(startScale:Number = 1, endScale:Number = 1)
The constructor creates a ScaleImage action for use by an emitter.
ScaleImage
 Inherited
addedToEmitter(emitter:Emitter):void
This method does nothing.
ActionBase
 Inherited
This method does nothing.
ActionBase
  
update(emitter:Emitter, particle:Particle, time:Number):void
[override] Sets the scale of the particle based on the values defined and the particle's energy level.
ScaleImage
Property Detail
endScaleproperty
endScale:Number

The scale factor for the particle when its energy is 0 - usually at the end of its lifetime. A scale of 1 is normal size.


Implementation
    public function get endScale():Number
    public function set endScale(value:Number):void
startScaleproperty 
startScale:Number

The scale factor for the particle when its energy is 1 - usually at the start of its lifetime. A scale of 1 is normal size.


Implementation
    public function get startScale():Number
    public function set startScale(value:Number):void
Constructor Detail
ScaleImage()Constructor
public function ScaleImage(startScale:Number = 1, endScale:Number = 1)

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

Parameters
startScale:Number (default = 1) — The scale factor for the particle when its energy is 1 - usually at the start of its lifetime. A scale of 1 is normal size.
 
endScale:Number (default = 1) — The scale factor for the particle when its energy is 0 - usually at the end of its lifetime. A scale of 1 is normal size.

See also

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

Sets the scale 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