Packageaway3d.materials
Classpublic class BitmapFileMaterial
InheritanceBitmapFileMaterial Inheritance TransformBitmapMaterial Inheritance BitmapMaterial Inheritance flash.events.EventDispatcher
ImplementsITriangleMaterial, IUVMaterial

Bitmap material that loads it's texture from an external bitmapasset file.

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
 InheritedglobalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
TransformBitmapMaterial
 Inheritedheight : Number
Returns the height of the bitmapData being used as the material texture.
BitmapMaterial
 InheritedoffsetX : Number
Offsets the x coordinates of the texture in uv-space
TransformBitmapMaterial
 InheritedoffsetY : Number
Offsets the y coordinates of the texture in uv-space
TransformBitmapMaterial
 Inheritedprecision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
BitmapMaterial
 InheritedprojectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
TransformBitmapMaterial
 Inheritedrepeat : Boolean
Determines if texture bitmap will tile in uv-space
BitmapMaterial
 Inheritedrotation : Number
Rotates the texture in uv-space
TransformBitmapMaterial
 InheritedscaleX : Number
Scales the x coordinates of the texture in uv-space
TransformBitmapMaterial
 InheritedscaleY : Number
Scales the y coordinates of the texture in uv-space
TransformBitmapMaterial
 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
 InheritedthroughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
TransformBitmapMaterial
 Inheritedtransform : Matrix
Transforms the texture in uv-space
TransformBitmapMaterial
 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
Public Methods
 MethodDefined by
  
BitmapFileMaterial
(url:String = "", init:Object = null)
Creates a new BitmapFileMaterial object.
BitmapFileMaterial
  
addOnLoadError(listener:Function):void
Default method for adding a loadError event listener
BitmapFileMaterial
  
addOnLoadProgress(listener:Function):void
Default method for adding a loadProgress event listener
BitmapFileMaterial
  
addOnLoadSuccess(listener:Function):void
Default method for adding a loadSuccess event listener
BitmapFileMaterial
 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
 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.
TransformBitmapMaterial
 Inherited
invalidateFaces(source:Object3D = null, view:View3D = null):void
Invalidates facematerial value objects when texturemapping requires updating
BitmapMaterial
  
removeOnLoadError(listener:Function):void
Default method for removing a loadError event listener
BitmapFileMaterial
  
removeOnLoadProgress(listener:Function):void
Default method for removing a loadProgress event listener
BitmapFileMaterial
  
removeOnLoadSuccess(listener:Function):void
Default method for removing a loadSuccess event listener
BitmapFileMaterial
 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
 Inherited
renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO
Renders a bitmapData surface object for the speficied face.
TransformBitmapMaterial
 Inherited
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
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.
TransformBitmapMaterial
 Inherited
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
TransformBitmapMaterial
Protected Methods
 MethodDefined by
 Inherited
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
TransformBitmapMaterial
 Inherited
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaterial
 Inherited
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
BitmapMaterial
Events
 EventSummaryDefined by
   Dispatched when the material fails to load a file.BitmapFileMaterial
   Dispatched every frame the material is loading.BitmapFileMaterial
   Dispatched when the material completes a file load successfully.BitmapFileMaterial
Constructor detail
BitmapFileMaterial()constructor
public function BitmapFileMaterial(url:String = "", init:Object = null)Parameters
url:String (default = "") — The location of the bitmapasset to load.
 
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
Method detail
addOnLoadError()method
public function addOnLoadError(listener:Function):void

Default method for adding a loadError event listener

Parameters
listener:Function — The listener function
addOnLoadProgress()method 
public function addOnLoadProgress(listener:Function):void

Default method for adding a loadProgress event listener

Parameters
listener:Function — The listener function
addOnLoadSuccess()method 
public function addOnLoadSuccess(listener:Function):void

Default method for adding a loadSuccess event listener

Parameters
listener:Function — The listener function
removeOnLoadError()method 
public function removeOnLoadError(listener:Function):void

Default method for removing a loadError event listener

Parameters
listener:Function — The listener function
removeOnLoadProgress()method 
public function removeOnLoadProgress(listener:Function):void

Default method for removing a loadProgress event listener

Parameters
listener:Function — The listener function
removeOnLoadSuccess()method 
public function removeOnLoadSuccess(listener:Function):void

Default method for removing a loadSuccess event listener

Parameters
listener:Function — The listener function
Event detail
loadErrorevent 
Event object type: away3d.events.LoaderEvent

Dispatched when the material fails to load a file.

loadProgressevent  
Event object type: away3d.events.LoaderEvent

Dispatched every frame the material is loading.

loadSuccessevent  
Event object type: away3d.events.LoaderEvent

Dispatched when the material completes a file load successfully.

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

Code examples

Comments