Packageorg.flashapi.coffeeshop.coffeebean.core
Classpublic class BlitTileTransitionBase
InheritanceBlitTileTransitionBase Inheritance BlitTransitionBase Inheritance flash.events.EventDispatcher
Implements BlitTileTransition
Subclasses MosaicBase, SlideBarBase, SnakeBase, WaterfallBase

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

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



Public Properties
 PropertyDefined By
  colsNum : uint
Sets or gets the number of columns that define the grid from which the tiles are cropped.
BlitTileTransitionBase
 InheritedframesNum : uint
Sets or gets the number of frames that can be used to split the animation.
BlitTransitionBase
  lag : Number
The lag property sets or gets the delay between each row, or line, displayed whithin a vertical or horizontal transition, such as sliding bars effects.
BlitTileTransitionBase
  rowsNum : uint
Sets or gets the number of rows that define the grid from which the tiles are cropped.
BlitTileTransitionBase
Protected Properties
 PropertyDefined By
 Inherited$canvas : BitmapData
A reference to the external BitmapData instance where the BlitTransition effect is rendered.
BlitTransitionBase
  $colsNum : uint
The number of columns that define the grid from which the tiles are cropped.
BlitTileTransitionBase
 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
  $height : Number
The height of theis BlitTileTransition instance.
BlitTileTransitionBase
 Inherited$initialState : BitmapData
A reference to the initial BitmapData instance.
BlitTransitionBase
  $lag : Number
The lag between the tiles, depending on the current effect.
BlitTileTransitionBase
  $mainRect : Rectangle
The Rectangle instance defined by the rect property of the $canvas object.
BlitTileTransitionBase
  $origin : Point
A Point object defined by the choordinates (0,0).
BlitTileTransitionBase
  $rowsNum : uint
The number of rows that define the grid from which the tiles are cropped.
BlitTileTransitionBase
  $tiles : Vector.<BitmapTile>
A reference to the Vector object that stores the BitmapTile objects used to create the BlitTileTransition effect.
BlitTileTransitionBase
  $tilesHeight : Number
The height of each tile that is used within this effect.
BlitTileTransitionBase
  $tilesWidth : Number
The width of each tile that is used within this effect.
BlitTileTransitionBase
  $width : Number
The width of theis BlitTileTransition instance.
BlitTileTransitionBase
Public Methods
 MethodDefined By
  
BlitTileTransitionBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)
Constructor.
BlitTileTransitionBase
  
finalize():void
[override] Use the finalize() method to ensure that all internal process of an object are killed before you delete it.
BlitTileTransitionBase
 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
 Inherited
update(frame:uint):void
Updates the blitting transition effect according to the current frame specified by the frame parameter.
BlitTransitionBase
Protected Methods
 MethodDefined By
  
Creates all the BitmapTile instances used to create the BlitTileTransition effect.
BlitTileTransitionBase
  
Deletes all the BitmapTile instances registered within this BlitTileTransition object.
BlitTileTransitionBase
 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
  
Update the time settings of all BitmapTile instances each time the framesNum property changes.
BlitTileTransitionBase
Property Detail
$colsNumproperty
protected var $colsNum:uint

The number of columns that define the grid from which the tiles are cropped.

See also

$heightproperty 
protected var $height:Number

The height of theis BlitTileTransition instance.

See also

$lagproperty 
protected var $lag:Number

The lag between the tiles, depending on the current effect.

See also

$mainRectproperty 
protected var $mainRect:Rectangle

The Rectangle instance defined by the rect property of the $canvas object.

See also

$originproperty 
protected var $origin:Point

A Point object defined by the choordinates (0,0).

$rowsNumproperty 
protected var $rowsNum:uint

The number of rows that define the grid from which the tiles are cropped.

See also

$tilesproperty 
protected var $tiles:Vector.<BitmapTile>

A reference to the Vector object that stores the BitmapTile objects used to create the BlitTileTransition effect.

$tilesHeightproperty 
protected var $tilesHeight:Number

The height of each tile that is used within this effect.

See also

$tilesWidthproperty 
protected var $tilesWidth:Number

The width of each tile that is used within this effect.

See also

$widthproperty 
protected var $width:Number

The width of theis BlitTileTransition instance.

See also

colsNumproperty 
colsNum:uint

Sets or gets the number of columns that define the grid from which the tiles are cropped.


Implementation
    public function get colsNum():uint
    public function set colsNum(value:uint):void
lagproperty 
lag:Number

The lag property sets or gets the delay between each row, or line, displayed whithin a vertical or horizontal transition, such as sliding bars effects. Values are in the range [0,1]. 0 means that all rows, or lines, are displayed at the same time; 1 means that each row, or line, waits that the preceding one is entirely displayed before it starts to be displayed.


Implementation
    public function get lag():Number
    public function set lag(value:Number):void
rowsNumproperty 
rowsNum:uint

Sets or gets the number of rows that define the grid from which the tiles are cropped.


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

Constructor. Creates a new BlitTileTransitionBase 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
createTiles()method
protected function createTiles():void

Creates all the BitmapTile instances used to create the BlitTileTransition effect.

See also

deleteTiles()method 
protected function deleteTiles():void

Deletes all the BitmapTile instances registered within this BlitTileTransition object.

See also

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.

updateTilesDuration()method 
protected function updateTilesDuration():void

Update the time settings of all BitmapTile instances each time the framesNum property changes.

See also