Packagefeathers.motion
Classpublic class Iris
InheritanceIris Inheritance Object

Product Version : Feathers 2.2.0

Creates effects for Feathers components and transitions for screen navigators that show or hide a display object masked by a growing or shrinking circle. In a transition, both display objects remain stationary while a stencil mask is animated.

Note: This effect is not supported with display objects that have transparent backgrounds due to limitations in stencil masks. Display objects should be fully opaque.

See also

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


Public Methods
 MethodDefined By
  
createIrisCloseEffect(duration:Number = 0.5, ease:Object, interruptBehavior:String):Function
[static] Creates an effect function for the target component that hides the component by masking it with a shrinking circle in the center.
Iris
  
createIrisCloseEffectAtRatio(ratioX:Number, ratioY:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function
[static] Creates an effect function for the target component that hides the component by masking it with a shrinking circle at a specific position in the range 0.0 to 1.0.
Iris
  
createIrisCloseEffectAtXY(x:Number, y:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function
[static] Creates an effect function for the target component that hides the component by masking it with a shrinking circle at a specific position.
Iris
  
createIrisCloseTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that hides a screen by masking it with a shrinking circle in the center.
Iris
  
createIrisCloseTransitionAt(x:Number, y:Number, duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that hides a screen by masking it with a shrinking circle at a specific position.
Iris
  
createIrisOpenEffect(duration:Number = 0.5, ease:Object, interruptBehavior:String):Function
[static] Creates an effect function for the target component that shows the component by masking it with a growing circle in the center.
Iris
  
createIrisOpenEffectAtRatio(ratioX:Number, ratioY:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function
[static] Creates an effect function for the target component that shows the component by masking it with a growing circle at a specific position in the range from 0.0 to 1.0.
Iris
  
createIrisOpenEffectAtXY(x:Number, y:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function
[static] Creates an effect function for the target component that shows the component by masking it with a growing circle at a specific position.
Iris
  
createIrisOpenTransition(duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that shows a screen by masking it with a growing circle in the center.
Iris
  
createIrisOpenTransitionAt(x:Number, y:Number, duration:Number = 0.5, ease:Object, tweenProperties:Object = null):Function
[static] Creates a transition function for a screen navigator that shows a screen by masking it with a growing circle at a specific position.
Iris
Method Detail
createIrisCloseEffect()method
public static function createIrisCloseEffect(duration:Number = 0.5, ease:Object, interruptBehavior:String):Function

Product Version : Feathers 3.5.0

Creates an effect function for the target component that hides the component by masking it with a shrinking circle in the center.

Parameters

duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
interruptBehavior:String (default = NaN)

Returns
Function

See also

createIrisCloseEffectAtRatio()method 
public static function createIrisCloseEffectAtRatio(ratioX:Number, ratioY:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function

Product Version : Feathers 3.5.0

Creates an effect function for the target component that hides the component by masking it with a shrinking circle at a specific position in the range 0.0 to 1.0.

Parameters

ratioX:Number
 
ratioY:Number
 
duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
interruptBehavior:String (default = NaN)

Returns
Function

See also

createIrisCloseEffectAtXY()method 
public static function createIrisCloseEffectAtXY(x:Number, y:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function

Product Version : Feathers 3.5.0

Creates an effect function for the target component that hides the component by masking it with a shrinking circle at a specific position.

Parameters

x:Number
 
y:Number
 
duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
interruptBehavior:String (default = NaN)

Returns
Function

See also

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

Creates a transition function for a screen navigator that hides a screen by masking it with a shrinking circle in the center.

Parameters

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

Returns
Function

See also

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

Creates a transition function for a screen navigator that hides a screen by masking it with a shrinking circle at a specific position.

Parameters

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

Returns
Function

See also

createIrisOpenEffect()method 
public static function createIrisOpenEffect(duration:Number = 0.5, ease:Object, interruptBehavior:String):Function

Product Version : Feathers 3.5.0

Creates an effect function for the target component that shows the component by masking it with a growing circle in the center.

Parameters

duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
interruptBehavior:String (default = NaN)

Returns
Function

See also

createIrisOpenEffectAtRatio()method 
public static function createIrisOpenEffectAtRatio(ratioX:Number, ratioY:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function

Product Version : Feathers 3.5.0

Creates an effect function for the target component that shows the component by masking it with a growing circle at a specific position in the range from 0.0 to 1.0.

Parameters

ratioX:Number
 
ratioY:Number
 
duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
interruptBehavior:String (default = NaN)

Returns
Function

See also

createIrisOpenEffectAtXY()method 
public static function createIrisOpenEffectAtXY(x:Number, y:Number, duration:Number = 0.5, ease:Object, interruptBehavior:String):Function

Product Version : Feathers 3.5.0

Creates an effect function for the target component that shows the component by masking it with a growing circle at a specific position.

Parameters

x:Number
 
y:Number
 
duration:Number (default = 0.5)
 
ease:Object (default = NaN)
 
interruptBehavior:String (default = NaN)

Returns
Function

See also

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

Creates a transition function for a screen navigator that shows a screen by masking it with a growing circle in the center.

Parameters

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

Returns
Function

See also

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

Creates a transition function for a screen navigator that shows a screen by masking it with a growing circle at a specific position.

Parameters

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

Returns
Function

See also