Packageorg.flashapi.coffeeshop.coffeebean.core
Classpublic class BlitTransitionBase
InheritanceBlitTransitionBase Inheritance flash.events.EventDispatcher
Implements BlitTransition
Subclasses BlindsBase, BlitTileTransitionBase, Blur, BoxBottomLeft, BoxBottomRight, BoxCenterBase, BoxTopLeft, BoxTopRight, ClockwiseBase, ColorTransitionBase, CornersBase, CurtainBase, DallasEffectBase, DiagonalBottomLeft, DiagonalBottomRight, DiagonalTopLeft, DiagonalTopRight, DoubleDiagonalLeftIn, DoubleDiagonalLeftOut, DoubleDiagonalRightIn, DoubleDiagonalRightOut, Fade, Freeze, IrisCircleBase, IrisEllipseBase, IrisRectangleBase, NullTransition, Pixelation, PushToBottom, PushToLeft, PushToRight, PushToTop, RotateBase, ScaleBase, SlideToBottom, SlideToLeft, SlideToRight, SlideToTop, ThreePointBase, TriangleBase

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

The BlitTransitionBase class is the base class for all BlitTransition objects.



Public Properties
 PropertyDefined By
  framesNum : uint
Sets or gets the number of frames that can be used to split the animation.
BlitTransitionBase
Protected Properties
 PropertyDefined By
  $canvas : BitmapData
A reference to the external BitmapData instance where the BlitTransition effect is rendered.
BlitTransitionBase
  $finalState : BitmapData
A reference to the final BitmapData instance.
BlitTransitionBase
  $frame : Number
A reference to the current frame position within this BlitTransition object.
BlitTransitionBase
  $framesNum : uint
The number of frames for this BlitTransition object.
BlitTransitionBase
  $initialState : BitmapData
A reference to the initial BitmapData instance.
BlitTransitionBase
Public Methods
 MethodDefined By
  
BlitTransitionBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)
Constructor.
BlitTransitionBase
  
finalize():void
Use the finalize() method to ensure that all internal process of an object are killed before you delete it.
BlitTransitionBase
  
getCanvas():BitmapData
Returns the blitting BitmapData where this BlitTransition object is rendered.
BlitTransitionBase
  
getFinalBitmap():BitmapData
Returns the BitmapData instance to which the effect transition finishes.
BlitTransitionBase
  
getFrame():uint
Returns the current frame of this BlitTransition object.
BlitTransitionBase
  
getHeight():Number
Returns the height, in pixels, of the blitting BitmapData where this BlitTransition object is rendered.
BlitTransitionBase
  
getInitialBitmap():BitmapData
Returns the BitmapData instance from which the effect transition starts.
BlitTransitionBase
  
getWidth():Number
Returns the width, in pixels, of the blitting BitmapData where this BlitTransition object is rendered.
BlitTransitionBase
  
update(frame:uint):void
Updates the blitting transition effect according to the current frame specified by the frame parameter.
BlitTransitionBase
Protected Methods
 MethodDefined By
  
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
Property Detail
$canvasproperty
protected var $canvas:BitmapData

A reference to the external BitmapData instance where the BlitTransition effect is rendered.

See also

$finalStateproperty 
protected var $finalState:BitmapData

A reference to the final BitmapData instance.

See also

$frameproperty 
protected var $frame:Number

A reference to the current frame position within this BlitTransition object.

See also

$framesNumproperty 
protected var $framesNum:uint

The number of frames for this BlitTransition object.

See also

$initialStateproperty 
protected var $initialState:BitmapData

A reference to the initial BitmapData instance.

See also

framesNumproperty 
framesNum:uint

Sets or gets the number of frames that can be used to split the animation.


Implementation
    public function get framesNum():uint
    public function set framesNum(value:uint):void
Constructor Detail
BlitTransitionBase()Constructor
public function BlitTransitionBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)

Constructor. Creates a new BlitTransitionBase 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
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.

getCanvas()method 
public function getCanvas():BitmapData

Returns the blitting BitmapData where this BlitTransition object is rendered.

Returns
BitmapData — The blitting BitmapData associated to this BlitTransition object.
getFinalBitmap()method 
public function getFinalBitmap():BitmapData

Returns the BitmapData instance to which the effect transition finishes.

Returns
BitmapData — The final BitmapData instance.
getFrame()method 
public function getFrame():uint

Returns the current frame of this BlitTransition object. The current frame is specified by the frame parameter each time the update() method is called.

Returns
uint — The current frame of this BlitTransition object.
getHeight()method 
public function getHeight():Number

Returns the height, in pixels, of the blitting BitmapData where this BlitTransition object is rendered.

Returns
Number — The height of the blitting BitmapData, in pixels.
getInitialBitmap()method 
public function getInitialBitmap():BitmapData

Returns the BitmapData instance from which the effect transition starts.

Returns
BitmapData — The initial BitmapData instance.
getWidth()method 
public function getWidth():Number

Returns the width, in pixels, of the blitting BitmapData where this BlitTransition object is rendered.

Returns
Number — The width of the blitting BitmapData, in pixels.
setFrame()method 
protected function 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].

Parameters

frame:uint — The current frame of the animation.

Returns
Number — The current position of the playhead within the animation.

See also

update()method 
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.