Iris - Adobe ActionScript® 3 (AS3 Flash) API Reference

Package	fl.transitions
Class	public class Iris
Inheritance	Iris Transition EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

The Iris class reveals the movie clip object by using an animated mask of a square shape or a circle shape that zooms in or out. This effect requires the following parameters:

startPoint: An integer indicating a starting position; the range is 1 to 9: Top Left:1; Top Center:2, Top Right:3; Left Center:4; Center:5; Right Center:6; Bottom Left:7; Bottom Center:8, Bottom Right:9.
shape: A mask shape of either fl.transitions.Iris.SQUARE (a square) or fl.transitions.Iris.CIRCLE (a circle).

For example, the following code uses a circle-shaped animated mask transition for the movie clip instance img1_mc:

 import fl.transitions.*;
 import fl.transitions.easing.*;
 
 TransitionManager.start(img1_mc, {type:Iris, direction:Transition.IN, duration:2, easing:Strong.easeOut, startPoint:5, shape:Iris.CIRCLE});

Copy

Related API Elements

fl.transitions.TransitionManager

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		direction : Number Determines the easing direction for the Tween instance.	Transition
		duration : Number Determines the length of time for the Tween instance.	Transition
		easing : Function Sets the tweening effect for the animation.	Transition

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		CIRCLE : String = "CIRCLE" [static] Used to specify a circle mask shape for the transition effect.	Iris
		SQUARE : String = "SQUARE" [static] Used to specify a square mask shape for the transition effect.	Iris

Constant Detail

CIRCLE

Constant

public static const CIRCLE:String = "CIRCLE"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Used to specify a circle mask shape for the transition effect.

SQUARE

Constant

public static const SQUARE:String = "SQUARE"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Used to specify a square mask shape for the transition effect.

Iris - AS3 Flash

Classes x

CIRCLE

SQUARE

fl.transitions Iris - AS3 Flash		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples