Packageaway3d.materials
Classpublic class BitmapMaterial
InheritanceBitmapMaterial Inheritance flash.events.EventDispatcher
ImplementsIBillboardMaterial, ILayerMaterial, ITriangleMaterial, IUVMaterial
SubclassesBitmapMaterialContainer, Dot3BitmapMaterialF10, TransformBitmapMaterial

Basic bitmap material

Public Properties
 PropertyDefined by
  alpha : Number
Defines an alpha value for the texture bitmap.
BitmapMaterial
  bitmap : BitmapData
Returns 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.
BitmapMaterial
  height : Number
[read-only] Returns the height of the bitmapData being used as the material texture.
BitmapMaterial
  id : int
[read-only] Unique identifier
BitmapMaterial
  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
  visible : Boolean
[read-only] Indicates whether the material is visible
BitmapMaterial
  width : Number
[read-only] Returns the width of the bitmapData being used as the material texture.
BitmapMaterial
Protected Properties
 PropertyDefined by
  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.
BitmapMaterial
Public Methods
 MethodDefined 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
BitmapMaterial
  
clearFaces(source:Object3D = null, view:View3D = null):void
Clears facematerial value objects when bitmap requires updating
BitmapMaterial
  
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
BitmapMaterial
  
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
BitmapMaterial
  
invalidateFaces(source:Object3D = null, view:View3D = null):void
Invalidates facematerial value objects when texturemapping requires updating
BitmapMaterial
  
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
BitmapMaterial
  
Sends data from the material coupled with data from the DrawBillboard primitive to the render session.
BitmapMaterial
  
renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO
Renders a bitmapData surface object for the speficied face.
BitmapMaterial
  
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int
Renders a material layer for the specified triangle.
BitmapMaterial
  
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
BitmapMaterial
  
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
BitmapMaterial
Protected Methods
 MethodDefined by
  
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
BitmapMaterial
  
getUVData(tri:DrawTriangle):Vector
BitmapMaterial
  
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaterial
  
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
BitmapMaterial
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]

Returns 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

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
debugproperty 
debug:Boolean  [read-write]

Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.

Implementation
    public function get debug():Boolean
    public function set debug(value:Boolean):void
heightproperty 
height:Number  [read-only]

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

Implementation
    public function get height():Number
idproperty 
id:int  [read-only]

Unique identifier

Implementation
    public function get id():int
iniproperty 
protected var 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.

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
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
visibleproperty 
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
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
 smooth:Boolean (default = false)
 debug:Boolean (default = false)
 repeat:Boolean (default = false)
 precision:Number (default = 0)
 blendMode:String (default = BlendMode.NORMAL)
 alpha:Number (default = _alpha, min:0, max:1)
 color:Color (default = _color)
 colorTransform:Object (default = ColorTransform)
 showNormals:Boolean (default = false)
Method detail
addOnMaterialUpdate()method
public function addOnMaterialUpdate(listener:Function):void

Default method for adding a materialupdated event listener

Parameters
listener:Function — The listener function
clearFaces()method 
public function clearFaces(source:Object3D = null, view:View3D = null):void

Clears facematerial value objects when bitmap requires updating

Parameters
source:Object3D (default = null) — [optional] The parent 3d object of the face.
 
view:View3D (default = null) — [optional] The view rendering the draw triangle.
getFaceMaterialVO()method 
public function getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO Parameters
faceVO:FaceVO
 
source:Object3D (default = null)
 
view:View3D (default = null)

Returns
FaceMaterialVO
getMapping()method 
protected function getMapping(tri:DrawTriangle):Matrix

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

Parameters
tri:DrawTriangle — The data object holding all information about the triangle to be drawn.

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 — The u (horizontal) texture coordinate.
 
v:Number — The v (verical) texture coordinate.

Returns
uint — The argb pixel value.
getUVData()method 
protected function getUVData(tri:DrawTriangle):Vector Parameters
tri:DrawTriangle

Returns
Vector
invalidateFaces()method 
public function invalidateFaces(source:Object3D = null, view:View3D = null):void

Invalidates facematerial value objects when texturemapping requires updating

Parameters
source:Object3D (default = null) — [optional] The parent 3d object of the face.
 
view:View3D (default = null) — [optional] The view rendering the draw triangle.
removeOnMaterialUpdate()method 
public function removeOnMaterialUpdate(listener:Function):void

Default method for removing a materialupdated event listener

Parameters
listener:Function — The listener function
renderBillboard()method 
public function renderBillboard(bill:DrawBillboard):void

Sends data from the material coupled with data from the DrawBillboard primitive to the render session.

Parameters
bill:DrawBillboard
renderBitmapLayer()method 
public function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO

Renders a bitmapData surface object for the speficied face.

Parameters
tri:DrawTriangle — The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle — The rectangle object defining the bounds of the face in uv-space.
 
parentFaceMaterialVO:FaceMaterialVO — The value object of the preceeding surface.

Returns
FaceMaterialVO
renderLayer()method 
public function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int

Renders a material layer for the specified triangle.

Parameters
tri:DrawTriangle — The drawtriangle used for render information.
 
layer:Sprite — The parent layer into which the triangle is drawn.
 
level:int — Defines the sprite level for the layer.

Returns
int
renderTriangle()method 
public function renderTriangle(tri:DrawTriangle):void

Sends data from the material coupled with data from the DrawTriangle primitive to the render session.

Parameters
tri:DrawTriangle
updateColorTransform()method 
protected function updateColorTransform():void

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

See also

color
alpha
updateMaterial()method 
public function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
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