Packageorg.flashapi.coffeeshop.coffeebean.core
Classpublic class SnakeBase
InheritanceSnakeBase Inheritance BlitTileTransitionBase Inheritance BlitTransitionBase Inheritance flash.events.EventDispatcher
Subclasses SnakeBottomLeftVertical, SnakeTopLeftHorizontal, SnakeTopLeftVertical, SnakeToptRightHorizontal

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

The SnakeBase class is the base class for all "snake" transitions.



Public Properties
 PropertyDefined By
 InheritedcolsNum : 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
 Inheritedlag : 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
 InheritedrowsNum : 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
 Inherited$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
 Inherited$height : Number
The height of theis BlitTileTransition instance.
BlitTileTransitionBase
 Inherited$initialState : BitmapData
A reference to the initial BitmapData instance.
BlitTransitionBase
 Inherited$lag : Number
The lag between the tiles, depending on the current effect.
BlitTileTransitionBase
 Inherited$mainRect : Rectangle
The Rectangle instance defined by the rect property of the $canvas object.
BlitTileTransitionBase
 Inherited$origin : Point
A Point object defined by the choordinates (0,0).
BlitTileTransitionBase
 Inherited$rowsNum : uint
The number of rows that define the grid from which the tiles are cropped.
BlitTileTransitionBase
 Inherited$tiles : Vector.<BitmapTile>
A reference to the Vector object that stores the BitmapTile objects used to create the BlitTileTransition effect.
BlitTileTransitionBase
 Inherited$tilesHeight : Number
The height of each tile that is used within this effect.
BlitTileTransitionBase
 Inherited$tilesWidth : Number
The width of each tile that is used within this effect.
BlitTileTransitionBase
 Inherited$width : Number
The width of theis BlitTileTransition instance.
BlitTileTransitionBase
Public Methods
 MethodDefined By
  
SnakeBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)
Constructor.
SnakeBase
 Inherited
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
  
update(frame:uint):void
[override] Updates the blitting transition effect according to the current frame specified by the frame parameter.
SnakeBase
Protected Methods
 MethodDefined By
 Inherited
Creates all the BitmapTile instances used to create the BlitTileTransition effect.
BlitTileTransitionBase
 Inherited
Deletes all the BitmapTile instances registered within this BlitTileTransition object.
BlitTileTransitionBase
  
getUnit():Number
Returns the ratio between the number of franes and the total number of tiles.
SnakeBase
 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
 Inherited
Update the time settings of all BitmapTile instances each time the framesNum property changes.
BlitTileTransitionBase
Constructor Detail
SnakeBase()Constructor
public function SnakeBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)

Constructor. Creates a new SnakeBase 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
getUnit()method
protected function getUnit():Number

Returns the ratio between the number of franes and the total number of tiles. This ratio represents the minimum unit of time to render the animation of each tile object.

Returns
Number — The minimum unit of time o render the animation of each tile object.
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.