Packageaway3d.materials
Classpublic class BitmapMaterialContainer
InheritanceBitmapMaterialContainer Inheritance BitmapMaterial Inheritance flash.events.EventDispatcher
ImplementsILayerMaterial, ITriangleMaterial
SubclassesDot3BitmapMaterialCache, EnviroBitmapMaterialCache, PhongBitmapMaterialCache, PhongColorMaterialCache

Container for caching multiple bitmapmaterial objects. Renders each material by caching a bitmapData surface object for each face. For continually updating materials, use CompositeMaterial.

See also

away3d.materials.CompositeMaterial
Public Properties
 PropertyDefined by
 Inheritedalpha : Number
Defines an alpha value for the texture bitmap.
BitmapMaterial
 Inheritedbitmap : BitmapData
Returns the bitmapData object being used as the material texture.
BitmapMaterial
 InheritedblendMode : String
Defines a blendMode value for the texture bitmap.
BitmapMaterial
 Inheritedcolor : uint
Defines a colored tint for the texture bitmap.
BitmapMaterial
 InheritedcolorTransform : 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.
BitmapMaterial
 Inheritedheight : Number
Returns the height of the bitmapData being used as the material texture.
BitmapMaterial
 Inheritedprecision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
BitmapMaterial
 Inheritedrepeat : Boolean
Determines if texture bitmap will tile in uv-space
BitmapMaterial
 InheritedshowNormals : Boolean
Displays the normals per face in pink lines.
BitmapMaterial
 Inheritedsmooth : Boolean
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
BitmapMaterial
  transparent : Boolean
Defines whether the caching bitmapData objects are transparent
BitmapMaterialContainer
 Inheritedvisible : Boolean
Indicates whether the material is visible
BitmapMaterial
 Inheritedwidth : Number
Returns the width of the bitmapData being used as the material texture.
BitmapMaterial
Protected Properties
 PropertyDefined by
 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.
BitmapMaterial
  materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
BitmapMaterialContainer
Public Methods
 MethodDefined by
  
BitmapMaterialContainer
(width:int, height:int, init:Object = null)
Creates a new BitmapMaterialContainer object.
BitmapMaterialContainer
  
addMaterial(material:ILayerMaterial):void
BitmapMaterialContainer
 Inherited
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
BitmapMaterial
 Inherited
clearFaces(source:Object3D = null, view:View3D = null):void
Clears facematerial value objects when bitmap requires updating
BitmapMaterial
  
BitmapMaterialContainer
 Inherited
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
BitmapMaterial
 Inherited
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
BitmapMaterial
 Inherited
invalidateFaces(source:Object3D = null, view:View3D = null):void
Invalidates facematerial value objects when texturemapping requires updating
BitmapMaterial
  
BitmapMaterialContainer
 Inherited
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
BitmapMaterial
 Inherited
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.
BitmapMaterialContainer
 Inherited
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int
Renders a material layer for the specified triangle.
BitmapMaterial
 Inherited
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
BitmapMaterial
  
updateMaterial(source:Object3D, view:View3D):void
Creates a new BitmapMaterialContainer object.
BitmapMaterialContainer
Protected Methods
 MethodDefined by
  
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
BitmapMaterialContainer
 Inherited
getUVData(tri:DrawTriangle):Vector
BitmapMaterial
 Inherited
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.
BitmapMaterialContainer
Property detail
materialsproperty
protected var materials:Array

An array of bitmapmaterial objects to be overlayed sequentially.

transparentproperty 
public var transparent:Boolean

Defines whether the caching bitmapData objects are transparent

Constructor detail
BitmapMaterialContainer()constructor
public function BitmapMaterialContainer(width:int, height:int, init:Object = null)Parameters
width:int — The containing width of the texture, applied to all child materials.
 
height:int — The containing height of the texture, applied to all child materials.
 
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 materials:Array
 transparent:Boolean (default = true)
Method detail
addMaterial()method
public function addMaterial(material:ILayerMaterial):void Parameters
material:ILayerMaterial
clearMaterials()method 
public function clearMaterials():void
getMapping()method 
protected override 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.
removeMaterial()method 
public function removeMaterial(material:ILayerMaterial):void Parameters
material:ILayerMaterial
renderBitmapLayer()method 
public override 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
updateMaterial()method 
public override function updateMaterial(source:Object3D, view:View3D):void

Creates a new BitmapMaterialContainer object.

Parameters
source:Object3D — The containing width of the texture, applied to all child materials.
 
view:View3D — The containing height of the texture, applied to all child materials.
updateRenderBitmap()method 
protected override function updateRenderBitmap():void

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

Wiki link
Click to go to the wiki page for 'away3d.materials.BitmapMaterialContainer'

Code examples

Comments