Packageaway3d.materials
Classpublic class BitmapMaskMaterial
InheritanceBitmapMaskMaterial Inheritance flash.events.EventDispatcher
ImplementsIBillboardMaterial, ILayerMaterial, ITriangleMaterial, IUVMaterial

Basic bitmap material

Public Properties
 PropertyDefined by
  alpha : Number
Defines an alpha value for the texture bitmap.
BitmapMaskMaterial
  bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
BitmapMaskMaterial
  blendMode : String
Defines a blendMode value for the texture bitmap.
BitmapMaskMaterial
  color : uint
Defines a colored tint for the texture bitmap.
BitmapMaskMaterial
  debug : Boolean
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
BitmapMaskMaterial
  height : Number
[read-only] Returns the height of the bitmapData being used as the material texture.
BitmapMaskMaterial
  offsetX : Number
[write-only]
BitmapMaskMaterial
  offsetY : Number
[write-only]
BitmapMaskMaterial
  precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
BitmapMaskMaterial
  repeat : Boolean
Determines if texture bitmap will tile in uv-space
BitmapMaskMaterial
  scaling : Number
[write-only]
BitmapMaskMaterial
  showNormals : Boolean
Displays the normals per face in pink lines.
BitmapMaskMaterial
  smooth : Boolean
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
BitmapMaskMaterial
  visible : Boolean
[read-only] Indicates whether the material is visible
BitmapMaskMaterial
  width : Number
[read-only] Returns the width of the bitmapData being used as the material texture.
BitmapMaskMaterial
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.
BitmapMaskMaterial
Public Methods
 MethodDefined by
  
BitmapMaskMaterial
(bitmap:BitmapData, init:Object = null)
BitmapMaskMaterial
  
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
BitmapMaskMaterial
  
clearFaces(source:Object3D = null, view:View3D = null):void
Clears facematerial value objects when bitmap requires updating
BitmapMaskMaterial
  
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
BitmapMaskMaterial
  
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
BitmapMaskMaterial
  
invalidateFaces(source:Object3D = null, view:View3D = null):void
Invalidates facematerial value objects when texturemapping requires updating
BitmapMaskMaterial
  
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
BitmapMaskMaterial
  
Sends data from the material coupled with data from the DrawBillboard primitive to the render session.
BitmapMaskMaterial
  
renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO
Renders a bitmapData surface object for the speficied face.
BitmapMaskMaterial
  
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int
Renders a material layer for the specified triangle.
BitmapMaskMaterial
  
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
BitmapMaskMaterial
  
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
BitmapMaskMaterial
Protected Methods
 MethodDefined by
  
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
BitmapMaskMaterial
  
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaskMaterial
  
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
BitmapMaskMaterial
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 BitmapMaskMaterialContainer or CompositeMaterial.

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

See also

away3d.materials.BitmapMaskMaterialContainer
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
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
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.

offsetXproperty 
offsetX:Number  [write-only]Implementation
    public function set offsetX(value:Number):void
offsetYproperty 
offsetY:Number  [write-only]Implementation
    public function set offsetY(value:Number):void
precisionproperty 
precision:Number  [read-write]

Corrects distortion caused by the affine transformation (non-perpective) 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
scalingproperty 
scaling:Number  [write-only]Implementation
    public function set scaling(value:Number):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
BitmapMaskMaterial()constructor
public function BitmapMaskMaterial(bitmap:BitmapData, init:Object = null)Parameters
bitmap:BitmapData
 
init:Object (default = null)
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)
 showNormals:Boolean (default = false)
 offsetX:Number (default = 0)
 offsetY:Number (default = 0)
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.
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.BitmapMaskMaterial'

Code examples

Comments