Packageorg.flashapi.coffeeshop.coffeebean
Classpublic class BoxTopLeft
InheritanceBoxTopLeft 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 BoxTopLeft class defines a transition between two images where the final image is displayed within a box that expands from the upper-left corner to the lower-right corner and progressively replaces the initial 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
Public Methods
 MethodDefined By
  
BoxTopLeft(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)
Constructor.
BoxTopLeft
  
finalize():void
[override] Use the finalize() method to ensure that all internal process of an object are killed before you delete it.
BoxTopLeft
 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.
BoxTopLeft
Protected Methods
 MethodDefined By
 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
BoxTopLeft()Constructor
public function BoxTopLeft(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)

Constructor. Creates a new BoxTopLeft 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
finalize()method
override public function finalize():void

Use the finalize() method to ensure that all internal process of an object are killed before you delete it. Typically, the finalize action should remove all events associated with this objects, and destroy somme objects such like BitmapData or NetConnection instances.

After calling this function you must set the object to null to definitely kill it.

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.