away3d.materials.AnimatedBitmapMaterial

Public Properties

	Property		Defined by
		alpha : Number The alpha of the surface.	BitmapMaterial
		ambient : Number The strength of the ambient reflection.	DefaultMaterialBase
		ambientColor : uint The colour of the ambient reflection.	DefaultMaterialBase
		ambientMethod : BasicAmbientMethod The method to perform diffuse shading.	DefaultMaterialBase
		autoPlay : Boolean	AnimatedBitmapMaterial
		bitmapData : BitmapData The BitmapData object to use as the texture.	BitmapMaterial
		blendMode : String The blend mode to use when drawing this renderable.	MaterialBase
		bothSides : Boolean Defines whether or not the material should perform backface culling.	MaterialBase
		colorTransform : ColorTransform The ColorTransform object to transform the colour of the material with.	DefaultMaterialBase
		diffuseMethod : BasicDiffuseMethod The method to perform diffuse shading.	DefaultMaterialBase
		extra : Object An object to contain any extra data	MaterialBase
		gloss : Number The sharpness of the specular highlight.	DefaultMaterialBase
		index : int returns the frame index of the animation.	AnimatedBitmapMaterial
		lights : Array	MaterialBase
		loop : Boolean	AnimatedBitmapMaterial
		materialNamespace : String The namespace of the material, used by the MaterialLibrary.	MaterialBase
		mipmap : Boolean	DefaultMaterialBase
		name : String The name of the material.	MaterialBase
		normalMap : BitmapData The tangent space normal map to influence the direction of the surface for each texel.	DefaultMaterialBase
		normalMapSources : Array [read-only] returns the frames of the animation.	AnimatedBitmapMaterial
		repeat : Boolean Indicates whether or not any used textures should be tiled.	MaterialBase
		requiresBlending : Boolean	BitmapMaterial
		shadowMethod : ShadingMethodBase The method to perform diffuse shading.	DefaultMaterialBase
		smooth : Boolean Indicates whether or not any used textures should use smoothing.	MaterialBase
		sources : Array [read-only] returns the frames of the animation.	AnimatedBitmapMaterial
		specular : Number The overall strength of the specular reflection.	DefaultMaterialBase
		specularColor : uint The colour of the specular reflection.	DefaultMaterialBase
		specularMap : BitmapData A specular map that defines the strength of specular reflections for each texel.	DefaultMaterialBase
		specularMethod : BasicSpecularMethod The method to perform specular shading.	DefaultMaterialBase
		transparent : Boolean Indicate whether or not the BitmapData contains transparency.	BitmapMaterial
		uniqueId : uint The unique id assigned to the material by the MaterialLibrary.	MaterialBase

	Property	Defined by
		_mipmap : Boolean	MaterialBase
		_numPasses : uint	MaterialBase
		_screenPass : DefaultScreenPass	DefaultMaterialBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		AnimatedBitmapMaterial (movie:MovieClip = null, loop:Boolean = true, autoPlay:Boolean = false, index:uint = 0, defaultBitmapData:BitmapData = null) Creates a new `AnimatedBitmapMaterial` object.	AnimatedBitmapMaterial
		addMethod(method:ShadingMethodBase):void	DefaultMaterialBase
		addMethodAt(method:ShadingMethodBase, index:int):void	DefaultMaterialBase
		clear(disposeNormalMaps:Boolean = false):void Manually clears all frames of the animation.	AnimatedBitmapMaterial
		dispose(deep:Boolean):void	BitmapMaterial
		isBitmapDataValid(bitmapData:BitmapData, id:uint = 0):Boolean	DefaultMaterialBase
		play():void Resumes playback of the animation	AnimatedBitmapMaterial
		removeMethod(method:ShadingMethodBase):void	DefaultMaterialBase
		setMaps(sources:Array, dispose:Boolean = false):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
		setNameAndSpace(name:String, materialNameSpace:String):void Sets the materials name and namespace.	MaterialBase
		setNormalMaps(nmsources:Array, dispose:Boolean = false):void Resets the cached normalMaps bitmapData objects making up the animation with a pre-defined array.	AnimatedBitmapMaterial
		stop():void Halts playback of the animation	AnimatedBitmapMaterial
		updateTexture():void Triggers an update of the texture, to be used when the contents of the BitmapData has changed.	BitmapMaterial

	Method	Defined by
		addPass(pass:MaterialPassBase):void Adds a pass to the material	MaterialBase
		clearPasses():void Clears all passes in the material.	MaterialBase

Property detail

autoPlay

property

autoPlay:Boolean  [read-write]Implementation
    public function get autoPlay():Boolean
    public function set autoPlay(value:Boolean):void

index

property

index:int [read-write]

returns the frame index of the animation.

Implementation
public function get index():int
public function set index(value:int):void

loop

property

loop:Boolean  [read-write]Implementation
    public function get loop():Boolean
    public function set loop(value:Boolean):void

normalMapSources

property

normalMapSources:Array [read-only]

returns the frames of the animation. an array of bitmapdatas

Implementation
public function get normalMapSources():Array

sources

property

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 = null, loop:Boolean = true, autoPlay:Boolean = false, index:uint = 0, defaultBitmapData:BitmapData = null)

Parameters

	`movie:MovieClip` (default = `null`) — [optional] The movieclip to be bitmap cached for use in the material. if no movieclip is provided, defaultBitmapData parameter must be set. Default is null.

	`loop:Boolean` (default = `true`) — [optional] If the sequence is played over and over.Default is true;

	`autoPlay:Boolean` (default = `false`) — [optional] If the sequence is playing automatically. Default is true;

	`index:uint` (default = `0`) — [optional] The index at which the sequence will start first. Default = 0;

	`defaultBitmapData:BitmapData` (default = `null`) — [optional] Default bitmapdata used till a setFrames or setMovie is used. Default = null;

Init Parameters

Method detail

clear

()

method

public function clear(disposeNormalMaps:Boolean = false):void

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

Parameters

disposeNormalMaps:Boolean (default = false) — If normalMaps needs to be disposed as well. Default is false;

play

()

method

public function play():void

Resumes playback of the animation

setMaps

()

method

public function setMaps(sources:Array, dispose:Boolean = false):void

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

Parameters

	`sources:Array` — If the previous sequence maps needs to be disposed. Default is false;

	`dispose:Boolean` (default = `false`)

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.

setNormalMaps

()

method

public function setNormalMaps(nmsources:Array, dispose:Boolean = false):void

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

Parameters

	`nmsources:Array` — If the previous sequence maps needs to be disposed. Default is false;

	`dispose:Boolean` (default = `false`)

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

Broomstick FP11 Trunk (as on 30-Mar-2011)	All Packages \| All Classes \| Index \| Frames No Frames
Class AnimatedBitmapMaterial		Properties \| Methods

Package	away3d.materials
Class	public class AnimatedBitmapMaterial
Inheritance	AnimatedBitmapMaterial BitmapMaterial DefaultMaterialBase MaterialBase