Packageorg.papervision3d.materials
Classpublic class BitmapMaterial
InheritanceBitmapMaterial Inheritance TriangleMaterial Inheritance MaterialObject3D Inheritance flash.events.EventDispatcher
ImplementsITriangleDrawer
SubclassesBitmapAssetMaterial, BitmapColorMaterial, BitmapFileMaterial, BitmapViewportMaterial, MovieMaterial

The BitmapMaterial class creates a texture from a BitmapData object. Materials collect data about how objects appear when rendered.



Public Properties
 PropertyDefined by
  AUTO_MIP_MAPPING : Boolean = false
[static] Indicates if mip mapping is forced.
BitmapMaterial
 Inheritedbitmap : BitmapData
A transparent or opaque BitmapData texture.
MaterialObject3D
 InheritedDEBUG : MaterialObject3D
[static]
MaterialObject3D
 InheritedDEBUG_COLOR : int = 0xFF00FF
[static] Color used for DEBUG material.
MaterialObject3D
 InheritedDEFAULT : MaterialObject3D
[static] Returns a MaterialObject3D object with the default magenta wireframe values.
MaterialObject3D
 InheritedDEFAULT_COLOR : int = 0x000000
[static] Color used for DEFAULT material.
MaterialObject3D
 InheriteddoubleSided : Boolean
A Boolean value that indicates whether the faces are double sided.
MaterialObject3D
 InheritedfillAlpha : Number = 0
An 8-bit alpha value fill the faces with.
MaterialObject3D
 InheritedfillColor : Number
A RGB color value to fill the faces with.
MaterialObject3D
  focus : Number = 100
BitmapMaterial
 InheritedheightOffset : Number = 0
Holds the original size of the bitmap before it was resized by Automip mapping
MaterialObject3D
 Inheritedid : Number
[internal-use] [read-only] Unique id of this instance.
MaterialObject3D
 Inheritedinteractive : Boolean = false
Defines if this material will be interactive;
MaterialObject3D
 Inheritedinvisible : Boolean = false
A Boolean value that indicates whether the faces are invisible (not drawn).
MaterialObject3D
 InheritedlineAlpha : Number = 0
An 8-bit alpha value for the faces outline.
MaterialObject3D
 InheritedlineColor : Number
A RGB color value to draw the faces outline.
MaterialObject3D
 InheritedlineThickness : Number = 1
An value for the thickness of the faces line.
MaterialObject3D
 InheritedmaxU : Number
Internal use
MaterialObject3D
 InheritedmaxV : Number
Internal use
MaterialObject3D
  minimumRenderSize : Number = 2
BitmapMaterial
  MIP_MAP_DEPTH : Number = 8
[static] Levels of mip mapping to force.
BitmapMaterial
 Inheritedname : String
The name of the material.
MaterialObject3D
 InheritedoneSide : Boolean = true
A Boolean value that indicates whether the faces are single sided.
MaterialObject3D
 Inheritedopposite : Boolean = false
A Boolean value that indicates whether the face is flipped.
MaterialObject3D
  precise : Boolean
BitmapMaterial
  precision : Number = 8
BitmapMaterial
 Inheritedscene : SceneObject3D
The scene where the object belongs.
MaterialObject3D
 Inheritedsmooth : Boolean = false
A Boolean value that determines whether the BitmapData texture is smoothed when rendered.
MaterialObject3D
  texture : Object
A texture object.
BitmapMaterial
 Inheritedtiled : Boolean = false
A Boolean value that determines whether the texture is tiled when rendered.
MaterialObject3D
  uvMatrices : Dictionary
BitmapMaterial
 InheritedwidthOffset : Number = 0
Holds the original size of the bitmap before it was resized by Automip mapping
MaterialObject3D
Protected Properties
 PropertyDefined by
 Inheritedobjects : Dictionary
MaterialObject3D
  _texture : Object
BitmapMaterial
  _triMap : Matrix
[static]
BitmapMaterial
Public Methods
 MethodDefined by
  
BitmapMaterial(asset:BitmapData = null, precise:Boolean = false)
The BitmapMaterial class creates a texture from a BitmapData object.
BitmapMaterial
  
Creates a copy of the material.
BitmapMaterial
  
copy(material:MaterialObject3D):void
Copies the properties of a material.
BitmapMaterial
  
drawTriangle(face3D:Triangle3D, graphics:Graphics, renderSessionData:RenderSessionData, altBitmap:BitmapData = null, altUV:Matrix = null):void
drawTriangle
BitmapMaterial
 Inherited
registerObject(displayObject3D:DisplayObject3D):void
MaterialObject3D
  
renderRec(graphics:Graphics, ta:Number, tb:Number, tc:Number, td:Number, tx:Number, ty:Number, ax:Number, ay:Number, az:Number, bx:Number, by:Number, bz:Number, cx:Number, cy:Number, cz:Number, index:Number, renderSessionData:RenderSessionData, bitmap:BitmapData):void
BitmapMaterial
  
renderTriangleBitmap(graphics:Graphics, a:Number, b:Number, c:Number, d:Number, tx:Number, ty:Number, v0x:Number, v0y:Number, v1x:Number, v1y:Number, v2x:Number, v2y:Number, smooth:Boolean, repeat:Boolean, bitmapData:BitmapData):void
BitmapMaterial
  
resetMapping():void
Resets the mapping coordinates.
BitmapMaterial
  
toString():String
Returns a string value representing the material properties in the specified BitmapMaterial object.
BitmapMaterial
  
transformUV(face3D:Triangle3D):Matrix
Applies the updated UV texture mapping values to the triangle.
BitmapMaterial
 Inherited
unregisterObject(displayObject3D:DisplayObject3D):void
MaterialObject3D
 Inherited
updateBitmap():void
Updates the BitmapData bitmap from the given texture.
MaterialObject3D
Protected Methods
 MethodDefined by
  
correctBitmap(bitmap:BitmapData):BitmapData
BitmapMaterial
  
createBitmap(asset:BitmapData):BitmapData
BitmapMaterial
 Inherited
destroy():void
MaterialObject3D
  
extendBitmapEdges(bmp:BitmapData, originalWidth:Number, originalHeight:Number):void
BitmapMaterial
Property detail
AUTO_MIP_MAPPINGproperty
public static var AUTO_MIP_MAPPING:Boolean = false

Indicates if mip mapping is forced.

focusproperty 
public var focus:Number = 100
minimumRenderSizeproperty 
public var minimumRenderSize:Number = 2
MIP_MAP_DEPTHproperty 
public static var MIP_MAP_DEPTH:Number = 8

Levels of mip mapping to force.

preciseproperty 
precise:Boolean  [read-write]Implementation
    public function get precise():Boolean
    public function set precise(value:Boolean):void
precisionproperty 
public var precision:Number = 8
_textureproperty 
protected var _texture:Object
textureproperty 
texture:Object  [read-write]

A texture object.

Implementation
    public function get texture():Object
    public function set texture(value:Object):void
_triMapproperty 
protected static var _triMap:Matrix
uvMatricesproperty 
public var uvMatrices:Dictionary
Constructor detail
BitmapMaterial()constructor
public function BitmapMaterial(asset:BitmapData = null, precise:Boolean = false)

The BitmapMaterial class creates a texture from a BitmapData object.

Parameters
asset:BitmapData (default = null) — A BitmapData object.
 
precise:Boolean (default = false)
Method detail
clone()method
public override function clone():MaterialObject3D

Creates a copy of the material.

Returns
MaterialObject3D — A newly created material that contains the same properties.
copy()method 
public override function copy(material:MaterialObject3D):void

Copies the properties of a material.

Parameters
material:MaterialObject3D — Material to copy from.
correctBitmap()method 
protected function correctBitmap(bitmap:BitmapData):BitmapDataParameters
bitmap:BitmapData

Returns
BitmapData
createBitmap()method 
protected function createBitmap(asset:BitmapData):BitmapDataParameters
asset:BitmapData

Returns
BitmapData
drawTriangle()method 
public override function drawTriangle(face3D:Triangle3D, graphics:Graphics, renderSessionData:RenderSessionData, altBitmap:BitmapData = null, altUV:Matrix = null):void

drawTriangle

Parameters
face3D:Triangle3D
 
graphics:Graphics
 
renderSessionData:RenderSessionData
 
altBitmap:BitmapData (default = null)
 
altUV:Matrix (default = null)
extendBitmapEdges()method 
protected function extendBitmapEdges(bmp:BitmapData, originalWidth:Number, originalHeight:Number):voidParameters
bmp:BitmapData
 
originalWidth:Number
 
originalHeight:Number
renderRec()method 
public function renderRec(graphics:Graphics, ta:Number, tb:Number, tc:Number, td:Number, tx:Number, ty:Number, ax:Number, ay:Number, az:Number, bx:Number, by:Number, bz:Number, cx:Number, cy:Number, cz:Number, index:Number, renderSessionData:RenderSessionData, bitmap:BitmapData):voidParameters
graphics:Graphics
 
ta:Number
 
tb:Number
 
tc:Number
 
td:Number
 
tx:Number
 
ty:Number
 
ax:Number
 
ay:Number
 
az:Number
 
bx:Number
 
by:Number
 
bz:Number
 
cx:Number
 
cy:Number
 
cz:Number
 
index:Number
 
renderSessionData:RenderSessionData
 
bitmap:BitmapData
renderTriangleBitmap()method 
public function renderTriangleBitmap(graphics:Graphics, a:Number, b:Number, c:Number, d:Number, tx:Number, ty:Number, v0x:Number, v0y:Number, v1x:Number, v1y:Number, v2x:Number, v2y:Number, smooth:Boolean, repeat:Boolean, bitmapData:BitmapData):voidParameters
graphics:Graphics
 
a:Number
 
b:Number
 
c:Number
 
d:Number
 
tx:Number
 
ty:Number
 
v0x:Number
 
v0y:Number
 
v1x:Number
 
v1y:Number
 
v2x:Number
 
v2y:Number
 
smooth:Boolean
 
repeat:Boolean
 
bitmapData:BitmapData
resetMapping()method 
public function resetMapping():void

Resets the mapping coordinates. Use when the texture has been resized.

toString()method 
public override function toString():String

Returns a string value representing the material properties in the specified BitmapMaterial object.

Returns
String — A string.
transformUV()method 
public function transformUV(face3D:Triangle3D):Matrix

Applies the updated UV texture mapping values to the triangle. This is required to speed up rendering.

Parameters
face3D:Triangle3D

Returns
Matrix