Packagefeathers.motion
Classpublic class Wipe
InheritanceWipe Inheritance Object

Product Version : Feathers 2.2.0

Creates effects for Feathers components and transitions for screen navigators that wipe a display object out of view, revealing another display object under the first. Both display objects remain stationary while the effect animates clipping rectangles. The clipping rectangles may be animated up, right, down, or left.

See also

Effects and animation for Feathers components
Transitions for Feathers screen navigators: Wipe


Public Methods
 MethodDefined By
  
createWipeDownTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that wipes the old screen down, animating the y and height properties of a clipRect, to reveal the new screen under it.
Wipe
  
createWipeInDownEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component into view from top to bottom, animating the height property of a temporary mask.
Wipe
  
createWipeInLeftEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component into view from right to left, animating the width and x properties of a temporary mask.
Wipe
  
createWipeInRightEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component into view from left to right, animating the width property of a temporary mask.
Wipe
  
createWipeInUpEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component into view from bottom to top, animating the height and y properties of a temporary mask.
Wipe
  
createWipeLeftTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that wipes the old screen out of view to the left, animating the width property of a clipRect, to reveal the new screen under it.
Wipe
  
createWipeOutDownEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component out of view from top to bottom, animating the height and y properties of a temporary mask.
Wipe
  
createWipeOutLeftEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component out of view from right to left, animating the width property of a temporary mask.
Wipe
  
createWipeOutRightEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component out of view from left to right, animating the width and x properties of a temporary mask.
Wipe
  
createWipeOutUpEffect(duration:Number = 0.25, ease:Object):Function
[static] Creates an effect function for the target component that wipes the target component out of view from bottom to top, animating the height property of a temporary mask.
Wipe
  
createWipeRightTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that wipes the old screen out of view to the right, animating the x and width properties of a clipRect, to reveal the new screen under it.
Wipe
  
createWipeUpTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that wipes the old screen up, animating the height property of a clipRect, to reveal the new screen under it.
Wipe
Method Detail
createWipeDownTransition()method
public static function createWipeDownTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function

Creates a transition function for a screen navigator that wipes the old screen down, animating the y and height properties of a clipRect, to reveal the new screen under it. The new screen remains stationary.

Parameters

duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
tweenProperties:Object (default = null)

Returns
Function

See also

createWipeInDownEffect()method 
public static function createWipeInDownEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component into view from top to bottom, animating the height property of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeInLeftEffect()method 
public static function createWipeInLeftEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component into view from right to left, animating the width and x properties of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeInRightEffect()method 
public static function createWipeInRightEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component into view from left to right, animating the width property of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeInUpEffect()method 
public static function createWipeInUpEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component into view from bottom to top, animating the height and y properties of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeLeftTransition()method 
public static function createWipeLeftTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function

Creates a transition function for a screen navigator that wipes the old screen out of view to the left, animating the width property of a clipRect, to reveal the new screen under it. The new screen remains stationary.

Parameters

duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
tweenProperties:Object (default = null)

Returns
Function

See also

createWipeOutDownEffect()method 
public static function createWipeOutDownEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component out of view from top to bottom, animating the height and y properties of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeOutLeftEffect()method 
public static function createWipeOutLeftEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component out of view from right to left, animating the width property of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeOutRightEffect()method 
public static function createWipeOutRightEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component out of view from left to right, animating the width and x properties of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeOutUpEffect()method 
public static function createWipeOutUpEffect(duration:Number = 0.25, ease:Object):Function

Creates an effect function for the target component that wipes the target component out of view from bottom to top, animating the height property of a temporary mask.

Parameters

duration:Number (default = 0.25)
 
ease:Object (default = NaN)

Returns
Function

See also

createWipeRightTransition()method 
public static function createWipeRightTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function

Creates a transition function for a screen navigator that wipes the old screen out of view to the right, animating the x and width properties of a clipRect, to reveal the new screen under it. The new screen remains stationary.

Parameters

duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
tweenProperties:Object (default = null)

Returns
Function

See also

createWipeUpTransition()method 
public static function createWipeUpTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function

Creates a transition function for a screen navigator that wipes the old screen up, animating the height property of a clipRect, to reveal the new screen under it. The new screen remains stationary.

Parameters

duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
tweenProperties:Object (default = null)

Returns
Function

See also