away3d.materials.BitmapFileMaterial

Public Properties

	Property		Defined by
		alpha : Number Defines an alpha value for the texture bitmap.	BitmapMaterial
		bitmap : BitmapData Defines the bitmapData object being used as the material texture.	BitmapMaterial
		blendMode : String Defines a blendMode value for the texture bitmap.	BitmapMaterial
		color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
		colorTransform : ColorTransform Defines a colortransform for the texture bitmap.	BitmapMaterial
		debug : Boolean Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	ColorMaterial
		globalProjection : Boolean Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.	TransformBitmapMaterial
		height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
		id : int Unique identifier	Material
		loader : Loader [read-only]	BitmapFileMaterial
		offsetX : Number Offsets the x coordinates of the texture in uv-space	TransformBitmapMaterial
		offsetY : Number Offsets the y coordinates of the texture in uv-space	TransformBitmapMaterial
		projectionVector : Number3D Projects the texture in object space, ignoring the uv coordinates of the vertex objects.	TransformBitmapMaterial
		repeat : Boolean Determines if texture bitmap will tile in uv-space	BitmapMaterial
		rotation : Number Rotates the texture in uv-space	TransformBitmapMaterial
		scaleX : Number Scales the x coordinates of the texture in uv-space	TransformBitmapMaterial
		scaleY : Number Scales the y coordinates of the texture in uv-space	TransformBitmapMaterial
		showNormals : Boolean Displays the normals per face in pink lines.	BitmapMaterial
		smooth : Boolean Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
		thickness : Number Determines the thickness value of the wire	WireframeMaterial
		throughProjection : Boolean Determines whether a projected texture is visble on the faces pointing away from the projection.	TransformBitmapMaterial
		transform : Matrix Transforms the texture in uv-space	TransformBitmapMaterial
		visible : Boolean Indicates whether the material is visible	WireColorMaterial
		width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial
		wireAlpha : Number Determines the alpha value of the wire	WireframeMaterial
		wireColor : uint 24 bit color value representing the wire color	WireframeMaterial

	Property	Defined by
		_alpha : Number	WireColorMaterial
		_color : uint	WireColorMaterial
		_debug : Boolean	ColorMaterial
		ini : 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
		_screenIndices : Array	BitmapMaterial
		_screenUVs : Array	BitmapMaterial
		_screenVertices : Array	BitmapMaterial
		_thickness : Number	WireframeMaterial
		_wireAlpha : Number	WireframeMaterial
		_wireColor : uint = 0x0	WireframeMaterial

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		BitmapFileMaterial (url:String = "", init:Object = null) Creates a new `BitmapFileMaterial` object.	BitmapFileMaterial
		addOnLoadError(listener:Function):void Default method for adding a loadError event listener	BitmapFileMaterial
		addOnLoadProgress(listener:Function):void Default method for adding a loadProgress event listener	BitmapFileMaterial
		addOnLoadSuccess(listener:Function):void Default method for adding a loadSuccess event listener	BitmapFileMaterial
		addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	Material
		clone(material:Material = null):Material Duplicates the material properties to another material object.	ColorMaterial
		getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	TransformBitmapMaterial
		removeOnLoadError(listener:Function):void Default method for removing a loadError event listener	BitmapFileMaterial
		removeOnLoadProgress(listener:Function):void Default method for removing a loadProgress event listener	BitmapFileMaterial
		removeOnLoadSuccess(listener:Function):void Default method for removing a loadSuccess event listener	BitmapFileMaterial
		removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	Material

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		getDefaultThickness():Number	WireframeMaterial
		getUVData(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Vector	TransformBitmapMaterial
		invalidateFaces(source:Object3D = null, view:View3D = null):void	BitmapMaterial
		renderSource(source:Object3D, containerRect:Rectangle, mapping:Matrix):void	BitmapMaterial
		updateColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
		updateFaces(source:Object3D = null, view:View3D = null):void	BitmapMaterial
		updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterial

Summary	Defined by
loadError	Dispatched when the material fails to load a file.	BitmapFileMaterial
loadProgress	Dispatched every frame the material is loading.	BitmapFileMaterial
loadSuccess	Dispatched when the material completes a file load successfully.	BitmapFileMaterial
materialUpdated	Dispatched when the any visual aspect of the material changes.	Material

Property detail

loader

property

loader:Loader [read-only]Implementation
public function get loader():Loader

Constructor detail

BitmapFileMaterial

()

constructor

public function BitmapFileMaterial(url:String = "", init:Object = null)Parameters

	`url:String` (default = "") — The location of the bitmapasset to load.

	`init:Object` (default = `null`) — [optional] An initialisation object for specifying default instance properties.

Init Parameters

checkPolicyFile:Boolean (default = false)

Method detail

addOnLoadError

()

method

public function addOnLoadError(listener:Function):void

Default method for adding a loadError event listener

Parameters

listener:Function — The listener function

addOnLoadProgress

()

method

public function addOnLoadProgress(listener:Function):void

Default method for adding a loadProgress event listener

Parameters

listener:Function — The listener function

addOnLoadSuccess

()

method

public function addOnLoadSuccess(listener:Function):void

Default method for adding a loadSuccess event listener

Parameters

listener:Function — The listener function

removeOnLoadError

()

method

public function removeOnLoadError(listener:Function):void

Default method for removing a loadError event listener

Parameters

listener:Function — The listener function

removeOnLoadProgress

()

method

public function removeOnLoadProgress(listener:Function):void

Default method for removing a loadProgress event listener

Parameters

listener:Function — The listener function

removeOnLoadSuccess

()

method

public function removeOnLoadSuccess(listener:Function):void

Default method for removing a loadSuccess event listener

Parameters

listener:Function — The listener function

Event detail

loadError

event

Event object type: away3d.events.MaterialEvent

Dispatched when the material fails to load a file.

loadProgress

event

Event object type: away3d.events.MaterialEvent

Dispatched every frame the material is loading.

loadSuccess

event

Event object type: away3d.events.MaterialEvent

Dispatched when the material completes a file load successfully.

Wiki link

Click to go to the wiki page for 'away3d.materials.BitmapFileMaterial'

Code examples

Comments

Away3D FP10 V3.5.2 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class BitmapFileMaterial		Properties \| Methods \| Events

Package	away3d.materials
Class	public class BitmapFileMaterial
Inheritance	BitmapFileMaterial TransformBitmapMaterial BitmapMaterial LayerMaterial ColorMaterial WireColorMaterial WireframeMaterial Material flash.events.EventDispatcher