Packageaway3d.materials
Classpublic class BitmapMaterial
InheritanceBitmapMaterial Inheritance LayerMaterial Inheritance ColorMaterial Inheritance WireColorMaterial Inheritance WireframeMaterial Inheritance Material Inheritance flash.events.EventDispatcher
SubclassesBitmapMaskMaterial, CompositeMaterial, TransformBitmapMaterial, WhiteShadingBitmapMaterial

Basic bitmap material

Public Properties
 PropertyDefined 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
 Inheriteddebug : 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
 Inheritedid : int
Unique identifier
Material
  precision : Number
Corrects distortion caused by the affine transformation (non-perspective) of textures.
BitmapMaterial
  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
 Inheritedthickness : Number
Determines the thickness value of the wire
WireframeMaterial
 Inheritedvisible : Boolean
Indicates whether the material is visible
WireColorMaterial
  width : Number
[read-only] 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
  _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
  _invtexmapping : Matrix
BitmapMaterial
  _screenIndices : Array
BitmapMaterial
  _screenVertices : Array
BitmapMaterial
 Inherited_thickness : Number
WireframeMaterial
  _u0 : Number
BitmapMaterial
  _u1 : Number
BitmapMaterial
  _u2 : Number
BitmapMaterial
  _v0 : Number
BitmapMaterial
  _v1 : Number
BitmapMaterial
  _v2 : Number
BitmapMaterial
 Inherited_wireAlpha : Number
WireframeMaterial
 Inherited_wireColor : uint = 0x0
WireframeMaterial
Public Methods
 MethodDefined by
  
BitmapMaterial
(bitmap:BitmapData, init:Object = null)
Creates a new BitmapMaterial object.
BitmapMaterial
 Inherited
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
Material
 Inherited
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.
BitmapMaterial
 Inherited
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
Material
Protected Methods
 MethodDefined by
 Inherited
WireframeMaterial
  
getMapping(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
BitmapMaterial
  
invalidateFaces(source:Object3D = null, view:View3D = null):void
BitmapMaterial
  
renderSource(source:Object3D, containerRect:Rectangle, mapping:Matrix):void
BitmapMaterial
  
transformUV(faceVO:FaceVO):Matrix
BitmapMaterial
  
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaterial
  
updateFaces(source:Object3D = null, view:View3D = null):void
BitmapMaterial
  
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
alphaproperty
alpha:Number  [read-write]

Defines an alpha value for the texture bitmap.

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
bitmapproperty 
bitmap:BitmapData  [read-write]

Defines the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
    public function set bitmap(value:BitmapData):void
blendModeproperty 
blendMode:String  [read-write]

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
colorproperty 
color:uint  [read-write]

Defines a colored tint for the texture bitmap.

Implementation
    public function get color():uint
    public function set color(value:uint):void
colorTransformproperty 
colorTransform:ColorTransform  [read-write]

Defines a colortransform for the texture bitmap.

Implementation
    public function get colorTransform():ColorTransform
    public function set colorTransform(value:ColorTransform):void
_commandsproperty 
protected var _commands:Array
heightproperty 
height:Number  [read-only]

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

Implementation
    public function get height():Number
_invtexmappingproperty 
protected var _invtexmapping:Matrix
precisionproperty 
precision:Number  [read-write]

Corrects distortion caused by the affine transformation (non-perspective) of textures. The number refers to the pixel correction value - ie. a value of 2 means a distorion correction to within 2 pixels of the correct perspective distortion. 0 performs no precision.

Implementation
    public function get precision():Number
    public function set precision(value:Number):void
repeatproperty 
repeat:Boolean  [read-write]

Determines if texture bitmap will tile in uv-space

Implementation
    public function get repeat():Boolean
    public function set repeat(value:Boolean):void
_screenIndicesproperty 
protected var _screenIndices:Array
_screenVerticesproperty 
protected var _screenVertices:Array
showNormalsproperty 
showNormals:Boolean  [read-write]

Displays the normals per face in pink lines.

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

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
_u0property 
protected var _u0:Number
_u1property 
protected var _u1:Number
_u2property 
protected var _u2:Number
_v0property 
protected var _v0:Number
_v1property 
protected var _v1:Number
_v2property 
protected var _v2:Number
widthproperty 
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)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 Parameters
 wireColor:Color (default = 0x0000FF)
 smooth:Boolean (default = false)
 debug:Boolean (default = false)
 repeat:Boolean (default = false)
 blendMode:String (default = BlendMode.NORMAL)
 colorTransform:Object (default = ColorTransform)
 showNormals:Boolean (default = false)
Method detail
getMapping()method
protected function getMapping(priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):Matrix

Calculates the mapping matrix required to draw the triangle texture to screen.

Parameters
priIndex:uint — The data object holding all information about the triangle to be drawn.
 
viewSourceObject:ViewSourceObject
 
renderer:Renderer

Returns
Matrix — The required matrix object.
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
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
transformUV()method 
protected function transformUV(faceVO:FaceVO):Matrix Parameters
faceVO:FaceVO

Returns
Matrix
updateColorTransform()method 
protected function updateColorTransform():void

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

See also

color
alpha
updateFaces()method 
protected function updateFaces(source:Object3D = null, view:View3D = null):void Parameters
source:Object3D (default = null)
 
view:View3D (default = null)
updateRenderBitmap()method 
protected function updateRenderBitmap():void

Updates the texture bitmapData with the colortransform determined from the color and alpha properties.

See also

color
alpha
setColorTransform()
Wiki link
Click to go to the wiki page for 'away3d.materials.BitmapMaterial'

Code examples

Comments