Packageaway3d.materials
Classpublic class AnimatedBitmapMaterial
InheritanceAnimatedBitmapMaterial Inheritance TransformBitmapMaterial Inheritance BitmapMaterial Inheritance flash.events.EventDispatcher
ImplementsITriangleMaterial, IUVMaterial

Bitmap material that allows fast rendering of animations by caching bitmapdata objects for each frame. Not suitable for use with long animations, where the initialisation time will be lengthy and the memory footprint large. If interactive movieclip properties are required, please refer to MovieMaterial.

Public Properties
 PropertyDefined by
 Inheritedalpha : Number
Defines an alpha value for the texture bitmap.
BitmapMaterial
  autoplay : Boolean
Indicates whether the animation will start playing on initialisation.
AnimatedBitmapMaterial
 Inheritedbitmap : BitmapData
Returns the bitmapData object being used as the material texture.
BitmapMaterial
 InheritedblendMode : String
Defines a blendMode value for the texture bitmap.
BitmapMaterial
 Inheritedcolor : uint
Defines a colored tint for the texture bitmap.
BitmapMaterial
 InheritedcolorTransform : ColorTransform
Defines a colortransform for the texture bitmap.
BitmapMaterial
 Inheriteddebug : Boolean
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
BitmapMaterial
 InheritedglobalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
TransformBitmapMaterial
 Inheritedheight : Number
Returns the height of the bitmapData being used as the material texture.
BitmapMaterial
  index : int
returns the frame index of the animation.
AnimatedBitmapMaterial
  loop : Boolean
Indicates whether the animation will loop.
AnimatedBitmapMaterial
 InheritedoffsetX : Number
Offsets the x coordinates of the texture in uv-space
TransformBitmapMaterial
 InheritedoffsetY : Number
Offsets the y coordinates of the texture in uv-space
TransformBitmapMaterial
 Inheritedprecision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
BitmapMaterial
 InheritedprojectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
TransformBitmapMaterial
 Inheritedrepeat : Boolean
Determines if texture bitmap will tile in uv-space
BitmapMaterial
 Inheritedrotation : Number
Rotates the texture in uv-space
TransformBitmapMaterial
 InheritedscaleX : Number
Scales the x coordinates of the texture in uv-space
TransformBitmapMaterial
 InheritedscaleY : Number
Scales the y coordinates of the texture in uv-space
TransformBitmapMaterial
 InheritedshowNormals : Boolean
Displays the normals per face in pink lines.
BitmapMaterial
 Inheritedsmooth : Boolean
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
BitmapMaterial
 InheritedthroughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
TransformBitmapMaterial
 Inheritedtransform : Matrix
Transforms the texture in uv-space
TransformBitmapMaterial
 Inheritedvisible : Boolean
Indicates whether the material is visible
BitmapMaterial
 Inheritedwidth : Number
Returns the width of the bitmapData being used as the material texture.
BitmapMaterial
Protected Properties
 PropertyDefined by
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
BitmapMaterial
Public Methods
 MethodDefined by
  
AnimatedBitmapMaterial
(movie:MovieClip, init:Object = null)
Creates a new AnimatedBitmapMaterial object.
AnimatedBitmapMaterial
 Inherited
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
BitmapMaterial
  
clear():void
Manually clears all frames of the animation.
AnimatedBitmapMaterial
 Inherited
clearFaces(source:Object3D = null, view:View3D = null):void
Clears facematerial value objects when bitmap requires updating
BitmapMaterial
 Inherited
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
BitmapMaterial
 Inherited
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
TransformBitmapMaterial
 Inherited
invalidateFaces(source:Object3D = null, view:View3D = null):void
Invalidates facematerial value objects when texturemapping requires updating
BitmapMaterial
  
play():void
Resumes playback of the animation
AnimatedBitmapMaterial
 Inherited
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
BitmapMaterial
 Inherited
Sends data from the material coupled with data from the DrawBillboard primitive to the render session.
BitmapMaterial
 Inherited
renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO
Renders a bitmapData surface object for the speficied face.
TransformBitmapMaterial
 Inherited
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int
Renders a material layer for the specified triangle.
BitmapMaterial
 Inherited
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
TransformBitmapMaterial
  
setFrames(sources:Array):void
Resets the cached bitmapData objects making up the animation with a pre-defined array.
AnimatedBitmapMaterial
  
setMovie(movie:MovieClip):void
Resets the movieclip used by the material.
AnimatedBitmapMaterial
  
stop():void
Halts playback of the animation
AnimatedBitmapMaterial
 Inherited
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
TransformBitmapMaterial
Protected Methods
 MethodDefined by
 Inherited
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
TransformBitmapMaterial
 Inherited
getUVData(tri:DrawTriangle):Vector
TransformBitmapMaterial
 Inherited
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaterial
 Inherited
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
BitmapMaterial
Property detail
autoplayproperty
public var autoplay:Boolean

Indicates whether the animation will start playing on initialisation. If false, only the first frame is displayed.

indexproperty 
index:int  [read-write]

returns the frame index of the animation.

Implementation
    public function get index():int
    public function set index(value:int):void
loopproperty 
public var loop:Boolean

Indicates whether the animation will loop.

Constructor detail
AnimatedBitmapMaterial()constructor
public function AnimatedBitmapMaterial(movie:MovieClip, init:Object = null)Parameters
movie:MovieClip — The movieclip to be bitmap cached for use in the material.
 
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 loop:Boolean (default = true)
 autoplay:Boolean (default = true)
 _index:Int (default = 0, min:0, max:movie.totalFrames - 1)
Method detail
clear()method
public function clear():void

Manually clears all frames of the animation. a new series of bitmapdatas will be required using the setFrames handler.

play()method 
public function play():void

Resumes playback of the animation

setFrames()method 
public function setFrames(sources:Array):void

Resets the cached bitmapData objects making up the animation with a pre-defined array.

Parameters
sources:Array
setMovie()method 
public function setMovie(movie:MovieClip):void

Resets the movieclip used by the material.

Parameters
movie:MovieClip — The movieclip to be bitmap cached for use in the material.
stop()method 
public function stop():void

Halts playback of the animation

Wiki link
Click to go to the wiki page for 'away3d.materials.AnimatedBitmapMaterial'

Code examples

Comments