Packagecom.greensock.easing
Classpublic final class ElasticOut
InheritanceElasticOut Inheritance Ease

Eases using a sine wave that starts fast and then decelerates over time.

Copyright 2012, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.


Public Properties
 PropertyDefined by
  ease : ElasticOut
[static] The default ease instance which can be reused many times in various tweens in order to conserve memory and improve performance slightly compared to creating a new instance each time.
ElasticOut
Public Methods
 MethodDefined by
  
ElasticOut(amplitude:Number = 0, period:Number = 0)
Constructor
ElasticOut
  
config(amplitude:Number = 0, period:Number = 0):ElasticOut
Permits customization of the ease with various parameters.
ElasticOut
  
getRatio(p:Number):Number
Translates the tween's progress ratio into the corresponding ease ratio.
ElasticOut
Property detail
easeproperty
public static var ease:ElasticOut

The default ease instance which can be reused many times in various tweens in order to conserve memory and improve performance slightly compared to creating a new instance each time.

Constructor detail
ElasticOut()constructor
public function ElasticOut(amplitude:Number = 0, period:Number = 0)

Constructor

Parameters
amplitude:Number (default = 0) — the amplitude of the sine wave (how exaggerated its movement is). Default is 0.
 
period:Number (default = 0) — the period of the sine wave (how far apart its waves are spaced, like its frequency). Default is 0.
Method detail
config()method
public function config(amplitude:Number = 0, period:Number = 0):ElasticOut

Permits customization of the ease with various parameters.

Parameters
amplitude:Number (default = 0) — the amplitude of the sine wave (how exaggerated its movement is). Default is 0.
 
period:Number (default = 0) — the period of the sine wave (how far apart its waves are spaced, like its frequency). Default is 0.

Returns
ElasticOut — new ElasticOut instance that is configured according to the parameters provided
getRatio()method 
public override function getRatio(p:Number):Number

Translates the tween's progress ratio into the corresponding ease ratio. This is the heart of the Ease, where it does all its work.

Parameters
p:Number — progress ratio (a value between 0 and 1 indicating the progress of the tween/ease)

Returns
Number — translated number