Packageaway3d.materials
Classpublic class AnimatedBitmapMaterial
InheritanceAnimatedBitmapMaterial Inheritance TransformBitmapMaterial Inheritance BitmapMaterial Inheritance LayerMaterial Inheritance ColorMaterial Inheritance WireColorMaterial Inheritance WireframeMaterial Inheritance Material Inheritance flash.events.EventDispatcher

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
Defines 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.
ColorMaterial
 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
 Inheritedid : int
Unique identifier
Material
  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-perspective) 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
  sources : Array
[read-only] returns the frames of the animation.
AnimatedBitmapMaterial
 Inheritedthickness : Number
Determines the thickness value of the wire
WireframeMaterial
 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
WireColorMaterial
 Inheritedwidth : Number
Returns the width of the bitmapData being used as the material texture.
BitmapMaterial
 InheritedwireAlpha : Number
Determines the alpha value of the wire
WireframeMaterial
 InheritedwireColor : uint
24 bit color value representing the wire color
WireframeMaterial
Protected Properties
 PropertyDefined by
 Inherited_alpha : Number
WireColorMaterial
 Inherited_color : uint
WireColorMaterial
 Inherited_commands : Array
BitmapMaterial
 Inherited_debug : Boolean
ColorMaterial
 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.
WireframeMaterial
 Inherited_invtexmapping : Matrix
BitmapMaterial
 Inherited_screenIndices : Array
BitmapMaterial
 Inherited_screenVertices : Array
BitmapMaterial
 Inherited_thickness : Number
WireframeMaterial
 Inherited_u0 : Number
BitmapMaterial
 Inherited_u1 : Number
BitmapMaterial
 Inherited_u2 : Number
BitmapMaterial
 Inherited_v0 : Number
BitmapMaterial
 Inherited_v1 : Number
BitmapMaterial
 Inherited_v2 : Number
BitmapMaterial
 Inherited_wireAlpha : Number
WireframeMaterial
 Inherited_wireColor : uint = 0x0
WireframeMaterial
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
Material
  
clear():void
Manually clears all frames of the animation.
AnimatedBitmapMaterial
 Inherited
clone(material:Material = null):Material
Duplicates the material properties to another material object.
ColorMaterial
 Inherited
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
TransformBitmapMaterial
  
play():void
Resumes playback of the animation
AnimatedBitmapMaterial
 Inherited
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
Material
  
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
Protected Methods
 MethodDefined by
 Inherited
WireframeMaterial
 Inherited
getMapping(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Matrix
TransformBitmapMaterial
 Inherited
invalidateFaces(source:Object3D = null, view:View3D = null):void
BitmapMaterial
 Inherited
renderSource(source:Object3D, containerRect:Rectangle, mapping:Matrix):void
BitmapMaterial
 Inherited
transformUV(faceVO:FaceVO):Matrix
BitmapMaterial
 Inherited
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaterial
 Inherited
updateFaces(source:Object3D = null, view:View3D = null):void
BitmapMaterial
 Inherited
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
BitmapMaterial
Events
 EventSummaryDefined by
 Inherited Dispatched when the any visual aspect of the material changes.Material
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.

sourcesproperty 
sources:Array  [read-only]

returns the frames of the animation. an array of bitmapdatas

Implementation
    public function get sources():Array
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:(_emb==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