View source

class IrisTransitionBuilder

package feathers.motion.transitions

Creates transitions for view navigators that show or hide a display object masked by a growing or shrinking circle. Both display objects remain stationary while a mask is animated.

Available since

1.0.0

.

See also:

Constructor

@:value({ duration : 0.5, originRatioY : 0.5, originRatioX : 0.5, open : true })new(open:Bool = true, originRatioX:Float = 0.5, originRatioY:Float = 0.5, duration:Float = 0.5, ?ease:IEasing)

Creates a new IrisTransitionBuilder object.

Available since

1.0.0

.

Methods

build():(DisplayObject, DisplayObject) ‑> IEffectContext

Returns the transition function.

Available since

1.0.0

.

setDuration(duration:Float):IrisTransitionBuilder

Sets the duration of the animation, measured in seconds.

Available since

1.0.0

.

setEase(ease:IEasing):IrisTransitionBuilder

Sets the easing function used for the animation.

Available since

1.0.0

.

setInterruptBehavior(interruptBehavior:EffectInterruptBehavior):IrisTransitionBuilder

Sets the behavior of the transition when it is interrupted (whether it stops at the current position or jumps immediately to the end).

Available since

1.0.0

.

setOpen(open:Bool):IrisTransitionBuilder

Sets whether the iris opens or closes.

Available since

1.0.0

.

setOriginRatioX(originRatioX:Float):IrisTransitionBuilder

Sets the x position of the origin, as a ratio of the view's width.

Available since

1.0.0

.

setOriginRatioY(originRatioY:Float):IrisTransitionBuilder

Sets the y position of the origin, as a ratio of the view's height.

Available since

1.0.0

.

setOriginX(originX:Float):IrisTransitionBuilder

Sets the x position of the origin, in pixels.

Available since

1.0.0

.

setOriginY(originY:Float):IrisTransitionBuilder

Sets the y position of the origin, in pixels.

Available since

1.0.0

.