away3d.materials.BitmapMaterial

	Property	Defined By
		alpha : Number [override] 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 [override] 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
		height : Number [read-only] Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
		id : int [read-only] Unique identifier	Material
		repeat : Boolean Determines if texture bitmap will tile in uv-space	BitmapMaterial
		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
		visible : Boolean [override] [read-only] Indicates whether the material is visible	WireColorMaterial
		width : Number [read-only] 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

[override] 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

[override] 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

height : Number

[read-only] Returns the height of the bitmapData being used as the material texture.

BitmapMaterial

id : int

[read-only] Unique identifier

Material

repeat : Boolean

Determines if texture bitmap will tile in uv-space

BitmapMaterial

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

visible : Boolean

[override] [read-only] Indicates whether the material is visible

WireColorMaterial

width : Number

[read-only] 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 : Vector.<int>	BitmapMaterial
		_screenUVTs : Vector.<Number>	BitmapMaterial
		_screenVertices : Vector.<Number>	BitmapMaterial
		_thickness : Number	WireframeMaterial
		_wireAlpha : Number	WireframeMaterial
		_wireColor : uint = 0x0	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 : Vector.<int>

BitmapMaterial

_screenUVTs : Vector.<Number>

BitmapMaterial

_screenVertices : Vector.<Number>

BitmapMaterial

_thickness : Number

WireframeMaterial

_wireAlpha : Number

WireframeMaterial

_wireColor : uint = 0x0

WireframeMaterial

	Method	Defined By
		BitmapMaterial(bitmap:BitmapData, init:Object = null) Creates a new BitmapMaterial object.	BitmapMaterial
		addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	Material
		clone(material:Material = null):Material [override] 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.	BitmapMaterial
		removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	Material

Method

Defined By

BitmapMaterial(bitmap:BitmapData, init:Object = null)

Creates a new BitmapMaterial object.

BitmapMaterial

addOnMaterialUpdate(listener:Function):void

Default method for adding a materialupdated event listener

Material

clone(material:Material = null):Material

[override] 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.

BitmapMaterial

removeOnMaterialUpdate(listener:Function):void

Default method for removing a materialupdated event listener

Material

	Method	Defined By
		getDefaultThickness():Number	WireframeMaterial
		getUVData(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Vector.<Number>	BitmapMaterial
		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

Method

Defined By

getDefaultThickness():Number

WireframeMaterial

getUVData(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Vector.<Number>

BitmapMaterial

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

	Event	Summary	Defined By
		materialUpdated	Dispatched when the any visual aspect of the material changes.	Material

Event

Summary

Defined By

materialUpdated

Dispatched when the any visual aspect of the material changes.

Material

Property Detail

_screenIndices

property

protected var _screenIndices:Vector.<int>

_screenUVTs

property

protected var _screenUVTs:Vector.<Number>

_screenVertices

property

protected var _screenVertices:Vector.<Number>

alpha

property

alpha:Number[override]

Defines an alpha value for the texture bitmap.

Implementation
public function get alpha():Number
public function set alpha(value:Number):void

bitmap

property

bitmap:BitmapData

Defines the bitmapData object being used as the material texture.

Implementation
public function get bitmap():BitmapData
public function set bitmap(value:BitmapData):void

blendMode

property

blendMode:String

Defines a blendMode value for the texture bitmap. Applies to materials rendered as children of BitmapMaterialContainer or CompositeMaterial.

Implementation
public function get blendMode():String
public function set blendMode(value:String):void

See also

away3d.materials.BitmapMaterialContainer
away3d.materials.CompositeMaterial

color

property

color:uint[override]

Defines a colored tint for the texture bitmap.

Implementation
public function get color():uint
public function set color(value:uint):void

colorTransform

property

colorTransform:ColorTransform

Defines a colortransform for the texture bitmap.

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

height

property

height:Number [read-only]

Returns the height of the bitmapData being used as the material texture.

Implementation
public function get height():Number

repeat

property

repeat:Boolean

Determines if texture bitmap will tile in uv-space

Implementation
public function get repeat():Boolean
public function set repeat(value:Boolean):void

showNormals

property

showNormals:Boolean

Displays the normals per face in pink lines.

Implementation
public function get showNormals():Boolean
public function set showNormals(value:Boolean):void

smooth

property

smooth:Boolean

Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.

Implementation
public function get smooth():Boolean
public function set smooth(value:Boolean):void

width

property

width:Number [read-only]

Returns the width of the bitmapData being used as the material texture.

Implementation
public function get width():Number

Constructor Detail

BitmapMaterial

()

Constructor

public function BitmapMaterial(bitmap:BitmapData, init:Object = null)

Creates a new BitmapMaterial object.

Parameters

	`bitmap:BitmapData` — The bitmapData object to be used as the material's texture.

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

####INIT####

Method Detail

getPixel32

()

method

public function getPixel32(u:Number, v:Number):uint

Returns the argb value of the bitmapData pixel at the given u v coordinate.

Parameters

	`u:Number`

	`v:Number`

Returns

uint

getUVData

()

method

protected function getUVData(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Vector.<Number>

Parameters

	`priIndex:uint`

	`viewSourceObject:ViewSourceObject`

	`renderer:Renderer`

Returns

Vector.<Number>

invalidateFaces

()

method

protected function invalidateFaces(source:Object3D = null, view:View3D = null):void

Parameters

	`source:Object3D` (default = `null`)

	`view:View3D` (default = `null`)

renderSource

()

method

protected function renderSource(source:Object3D, containerRect:Rectangle, mapping:Matrix):void

Parameters

	`source:Object3D`

	`containerRect:Rectangle`

	`mapping:Matrix`

updateColorTransform

()

method

protected function updateColorTransform():void

Updates the colortransform object applied to the texture from the color and alpha properties.

Away3D FP10 V3.6.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
BitmapMaterial	Properties \| Methods \| Events

Package	away3d.materials
Class	public class BitmapMaterial
Inheritance	BitmapMaterial LayerMaterial ColorMaterial WireColorMaterial WireframeMaterial Material flash.events.EventDispatcher
Subclasses	BitmapMaskMaterial, CompositeMaterial, Dot3BitmapMaterialF10, TransformBitmapMaterial, WhiteShadingBitmapMaterial