Packageverlocity.display
Classpublic final class BitmapClip
InheritanceBitmapClip Inheritance flash.events.EventDispatcher



Public Properties
 PropertyDefined By
  bitmapData : BitmapData
[read-only]
BitmapClip
  bitmapDataRect : Rectangle
[read-only]
BitmapClip
  center : Point
[read-only]
BitmapClip
  colorTransform : ColorTransform
BitmapClip
  currentAnimation : int
Sets the current Animation to be displayed
BitmapClip
  currentFrame : int
[read-only]
BitmapClip
  frameRate : int
BitmapClip
  height : int
[read-only]
BitmapClip
  rotation : int
BitmapClip
  scaleSmoothing : Boolean
BitmapClip
  scaleX : Number = 1
BitmapClip
  scaleY : Number = 1
BitmapClip
  sourceClass : Class
BitmapClip
  totalFrames : int
[read-only]
BitmapClip
  width : int
[read-only]
BitmapClip
  x : Number = 0
BitmapClip
  y : Number = 0
BitmapClip
Public Methods
 MethodDefined By
  
BitmapClip(clipToCopy:BitmapClip = null, framesOfRotation:int = 32)
BitmapClip
  
_Dispose():void
BitmapClip
  
_Update():void
Updates the animation of the BitmapClip
BitmapClip
  
gotoAndPlay(frame:int):void
BitmapClip
  
gotoAndStop(frame:int):void
BitmapClip
  
importFrames(source:MovieClip, startFrame:int = 1, endFrame:int = 0):int
Adds an animation to the collection
BitmapClip
  
importSprite(source:Sprite):int
Adds an animation to the collection
BitmapClip
  
importTileSheet(source:BitmapData, tileWidth:int, tileHeight:int, columnsToCopy:int = 0, rowsToCopy:int = 0, startPos:Point = null):int
Imports a "tilesheet" in.
BitmapClip
  
nextFrame():void
BitmapClip
  
play():void
BitmapClip
  
prevFrame():void
BitmapClip
  
reuseClipData(bitmapClip:BitmapClip):void
Use this function to copy data from a bitmapClip that has already been created.
BitmapClip
  
stop():void
BitmapClip
Property Detail
bitmapDataproperty
bitmapData:BitmapData  [read-only]


Implementation
    public function get bitmapData():BitmapData
bitmapDataRectproperty 
bitmapDataRect:Rectangle  [read-only]


Implementation
    public function get bitmapDataRect():Rectangle
centerproperty 
center:Point  [read-only]


Implementation
    public function get center():Point
colorTransformproperty 
colorTransform:ColorTransform


Implementation
    public function get colorTransform():ColorTransform
    public function set colorTransform(value:ColorTransform):void
currentAnimationproperty 
currentAnimation:int

Sets the current Animation to be displayed


Implementation
    public function get currentAnimation():int
    public function set currentAnimation(value:int):void
currentFrameproperty 
currentFrame:int  [read-only]


Implementation
    public function get currentFrame():int
frameRateproperty 
frameRate:int


Implementation
    public function get frameRate():int
    public function set frameRate(value:int):void
heightproperty 
height:int  [read-only]


Implementation
    public function get height():int
rotationproperty 
rotation:int


Implementation
    public function get rotation():int
    public function set rotation(value:int):void
scaleSmoothingproperty 
public var scaleSmoothing:Boolean

scaleXproperty 
public var scaleX:Number = 1

scaleYproperty 
public var scaleY:Number = 1

sourceClassproperty 
public var sourceClass:Class

totalFramesproperty 
totalFrames:int  [read-only]


Implementation
    public function get totalFrames():int
widthproperty 
width:int  [read-only]


Implementation
    public function get width():int
xproperty 
public var x:Number = 0

yproperty 
public var y:Number = 0

Constructor Detail
BitmapClip()Constructor
public function BitmapClip(clipToCopy:BitmapClip = null, framesOfRotation:int = 32)



Parameters
clipToCopy:BitmapClip (default = null)
 
framesOfRotation:int (default = 32)
Method Detail
_Dispose()method
public function _Dispose():void

_Update()method 
public function _Update():void

Updates the animation of the BitmapClip

gotoAndPlay()method 
public function gotoAndPlay(frame:int):void

Parameters

frame:int

gotoAndStop()method 
public function gotoAndStop(frame:int):void

Parameters

frame:int

importFrames()method 
public function importFrames(source:MovieClip, startFrame:int = 1, endFrame:int = 0):int

Adds an animation to the collection

Parameters

source:MovieClip — Takes a MovieClip
 
startFrame:int (default = 1) — Frame to start importing from. Default is 1.
 
endFrame:int (default = 0) — Copy all frames up to this frame. Leave at 0 to get all frames.

Returns
int — the index to the created Animation
importSprite()method 
public function importSprite(source:Sprite):int

Adds an animation to the collection

Parameters

source:Sprite — Takes a Sprite

Returns
int — the index to the created Animation
importTileSheet()method 
public function importTileSheet(source:BitmapData, tileWidth:int, tileHeight:int, columnsToCopy:int = 0, rowsToCopy:int = 0, startPos:Point = null):int

Imports a "tilesheet" in. Give it a BitmapData object which stores your tiles.

Parameters

source:BitmapData
 
tileWidth:int
 
tileHeight:int
 
columnsToCopy:int (default = 0)
 
rowsToCopy:int (default = 0)
 
startPos:Point (default = null)

Returns
int
nextFrame()method 
public function nextFrame():void

play()method 
public function play():void

prevFrame()method 
public function prevFrame():void

reuseClipData()method 
public function reuseClipData(bitmapClip:BitmapClip):void

Use this function to copy data from a bitmapClip that has already been created. This will speed up object creation IMMENSELY. It is highly recommended that you use this.

Parameters

bitmapClip:BitmapClip

stop()method 
public function stop():void