Packageorg.flashapi.coffeeshop.coffeebean.core
Classpublic class ThreePointBase
InheritanceThreePointBase Inheritance BlitTransitionBase Inheritance flash.events.EventDispatcher
Subclasses BowTieBase, DoubleBarnDoorIn, DoubleBarnDoorOut, DoubleDiamondIn, DoubleDiamondOut, FanBottomBase, FanLeftBase, FanRightBase, FanTopBase, IrisDiamondBase, VeeDownBase, VeeLeftBase, VeeRightBase, VeeUpBase

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

The ThreePointBase class defines is the base class for transitions that use pre-defined points to define triangular shapes.



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
  $aPt : Point
A Point defined by the coordinates of the first vertice of the current triangle.
ThreePointBase
  $bPt : Point
A Point defined by the coordinates of the second vertice of the current triangle.
ThreePointBase
 Inherited$canvas : BitmapData
A reference to the external BitmapData instance where the BlitTransition effect is rendered.
BlitTransitionBase
  $cPt : Point
A Point defined by the coordinates of the third vertice of the current triangle.
ThreePointBase
 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
  $halfHeight : Number
The half height of the main canvas (height / 2), in pixels.
ThreePointBase
  $halfWidth : Number
The half width of the main canvas (width / 2), in pixels.
ThreePointBase
  $height : Number
The height of the main canvas, in pixels.
ThreePointBase
 Inherited$initialState : BitmapData
A reference to the initial BitmapData instance.
BlitTransitionBase
  $mainRect : Rectangle
The rectangle defined by the main canvas bounds.
ThreePointBase
  $origin : Point
The origin point of the main canvas, specified by the coordinates (0,0).
ThreePointBase
  $width : Number
The width of the main canvas, in pixels.
ThreePointBase
Public Methods
 MethodDefined By
  
ThreePointBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)
Constructor.
ThreePointBase
  
finalize():void
[override] Use the finalize() method to ensure that all internal process of an object are killed before you delete it.
ThreePointBase
 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
 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
Property Detail
$aPtproperty
protected var $aPt:Point

A Point defined by the coordinates of the first vertice of the current triangle.

See also

$bPtproperty 
protected var $bPt:Point

A Point defined by the coordinates of the second vertice of the current triangle.

See also

$cPtproperty 
protected var $cPt:Point

A Point defined by the coordinates of the third vertice of the current triangle.

See also

$halfHeightproperty 
protected var $halfHeight:Number

The half height of the main canvas (height / 2), in pixels.

See also

$halfWidthproperty 
protected var $halfWidth:Number

The half width of the main canvas (width / 2), in pixels.

See also

$heightproperty 
protected var $height:Number

The height of the main canvas, in pixels.

See also

$mainRectproperty 
protected var $mainRect:Rectangle

The rectangle defined by the main canvas bounds.

$originproperty 
protected var $origin:Point

The origin point of the main canvas, specified by the coordinates (0,0).

$widthproperty 
protected var $width:Number

The width of the main canvas, in pixels.

See also

Constructor Detail
ThreePointBase()Constructor
public function ThreePointBase(canvas:BitmapData, initialState:BitmapData, finalState:BitmapData)

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