Packageorg.flashapi.coffeeshop.coffeebean
Classpublic class IrisCircleIn
InheritanceIrisCircleIn Inheritance IrisCircleBase Inheritance BlitTransitionBase Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : SPAS 3.0
Runtime Versions : AIR 1.0, Flash Player Player - 9

The IrisCircleIn class defines a transition between two images where the initial image is displayed within a circle that collapses from the edges to the center of the canvas and is progressively replaced by the final image.



Public Properties
 PropertyDefined By
 InheritedframesNum : uint
Sets or gets the number of frames that can be used to split the animation.
BlitTransitionBase
Protected Properties
 PropertyDefined By
 Inherited$canvas : BitmapData
A reference to the external BitmapData instance where the BlitTransition effect is rendered.
BlitTransitionBase
 Inherited$finalState : BitmapData
A reference to the final BitmapData instance.
BlitTransitionBase
 Inherited$frame : Number
A reference to the current frame position within this BlitTransition object.
BlitTransitionBase
 Inherited$framesNum : uint
The number of frames for this BlitTransition object.
BlitTransitionBase
 Inherited$initialState : BitmapData
A reference to the initial BitmapData instance.
BlitTransitionBase
 Inherited$multiplier : Number
The ratio between the width and height of the BitmapData whrer the effect is rendered.
IrisCircleBase
Public Methods
 MethodDefined By
  
IrisCircleIn(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)
Constructor.
IrisCircleIn
 Inherited
finalize():void
[override] Use the finalize() method to ensure that all internal process of an object are killed before you delete it.
IrisCircleBase
 Inherited
getCanvas():BitmapData
Returns the blitting BitmapData where this BlitTransition object is rendered.
BlitTransitionBase
 Inherited
getFinalBitmap():BitmapData
Returns the BitmapData instance to which the effect transition finishes.
BlitTransitionBase
 Inherited
getFrame():uint
Returns the current frame of this BlitTransition object.
BlitTransitionBase
 Inherited
getHeight():Number
Returns the height, in pixels, of the blitting BitmapData where this BlitTransition object is rendered.
BlitTransitionBase
 Inherited
getInitialBitmap():BitmapData
Returns the BitmapData instance from which the effect transition starts.
BlitTransitionBase
 Inherited
getWidth():Number
Returns the width, in pixels, of the blitting BitmapData where this BlitTransition object is rendered.
BlitTransitionBase
  
update(frame:uint):void
[override] Updates the blitting transition effect according to the current frame specified by the frame parameter.
IrisCircleIn
Protected Methods
 MethodDefined By
 Inherited
renderCircle(radius:uint, from:BitmapData, to:BitmapData):void
Draws circular transitions.
IrisCircleBase
 Inherited
setFrame(frame:uint):Number
Sets the current frame of the animation and returns the current position of the playhead within the animation, in the range [0, 1].
BlitTransitionBase
Constructor Detail
IrisCircleIn()Constructor
public function IrisCircleIn(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)

Constructor. Creates a new IrisCircleIn instance with the specified parameters.

Parameters
canvas:BitmapData — The BitmapData object where the effect is rendered.
 
initialState:BitmapData — The first BitmapData object used to render the effect.
 
finalState:BitmapData — The second BitmapData object used to render the effect.
Method Detail
update()method
override public function update(frame:uint):void

Updates the blitting transition effect according to the current frame specified by the frame parameter.

Parameters

frame:uint — The current frame of the animation in the range [0, f], where f defines number of frames that can be used to split the animation.