Packageorg.papervision3d.materials
Classpublic class BitmapMaterial
InheritanceBitmapMaterial Inheritance MaterialObject3D Inheritance flash.events.EventDispatcher
ImplementsIFaceDrawer
SubclassesBitmapAssetMaterial, BitmapColorMaterial, BitmapFileMaterial, BitmapWireframeMaterial, InteractiveBitmapMaterial, 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
An 8-bit alpha value fill the faces with.
MaterialObject3D
 InheritedfillColor : Number
A RGB color value to fill the faces with.
MaterialObject3D
  heightOffset : Number = 0
BitmapMaterial
 Inheritedid : Number
[internal-use] [read-only] Unique id of this instance.
MaterialObject3D
 Inheritedinvisible : Boolean
A Boolean value that indicates whether the faces are invisible (not drawn).
MaterialObject3D
 InheritedlineAlpha : Number
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
  MIP_MAP_DEPTH : Number = 8
[static] Levels of mip mapping to force.
BitmapMaterial
 Inheritedname : String
The name of the material.
MaterialObject3D
 InheritedneedsFaceNormals : Boolean = false
Defines if face normals need to be rotated for this material.
MaterialObject3D
 InheritedoneSide : Boolean
A Boolean value that indicates whether the faces are single sided.
MaterialObject3D
 Inheritedopposite : Boolean
A Boolean value that indicates whether the face is flipped.
MaterialObject3D
 Inheritedscene : SceneObject3D
The scene where the object belongs.
MaterialObject3D
 Inheritedsmooth : Boolean
A Boolean value that determines whether the BitmapData texture is smoothed when rendered.
MaterialObject3D
  texture : *
A texture object.
BitmapMaterial
  uvMatrices : Dictionary
BitmapMaterial
  widthOffset : Number = 0
BitmapMaterial
Protected Properties
 PropertyDefined by
  _localMatrix : Matrix
[static]
BitmapMaterial
  _texture : *
BitmapMaterial
  _triMatrix : Matrix
[static]
BitmapMaterial
Public Methods
 MethodDefined by
  
BitmapMaterial(asset:*, initObject:Object = null)
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
  
correctBitmap(bitmap:BitmapData, dispose:Boolean):BitmapData
BitmapMaterial
  
drawFace3D(instance:DisplayObject3D, face3D:Face3D, graphics:Graphics, v0:Vertex2D, v1:Vertex2D, v2:Vertex2D):int
drawFace3D
BitmapMaterial
  
toString():String
Returns a string value representing the material properties in the specified BitmapMaterial object.
BitmapMaterial
  
transformUV(face3D:Face3D, instance:DisplayObject3D = null):Matrix
Applies the updated UV texture mapping values to the triangle.
BitmapMaterial
 Inherited
updateBitmap():void
Updates the BitmapData bitmap from the given texture.
MaterialObject3D
Protected Methods
 MethodDefined by
  
createBitmap(asset:*):BitmapData
BitmapMaterial
  
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.

heightOffsetproperty 
public var heightOffset:Number = 0
_localMatrixproperty 
protected static var _localMatrix:Matrix
MIP_MAP_DEPTHproperty 
public static var MIP_MAP_DEPTH:Number = 8

Levels of mip mapping to force.

_textureproperty 
protected var _texture:*
textureproperty 
texture:*  [read-write]

A texture object.

Implementation
    public function get texture():*
    public function set texture(value:*):void
_triMatrixproperty 
protected static var _triMatrix:Matrix
uvMatricesproperty 
public var uvMatrices:Dictionary
widthOffsetproperty 
public var widthOffset:Number = 0
Constructor detail
BitmapMaterial()constructor
public function BitmapMaterial(asset:*, initObject:Object = null)

The BitmapMaterial class creates a texture from a BitmapData object.

Parameters
asset:* — A BitmapData object.
 
initObject:Object (default = null) — [optional] - An object that contains additional properties with which to populate the newly created material.
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 
public function correctBitmap(bitmap:BitmapData, dispose:Boolean):BitmapDataParameters
bitmap:BitmapData
 
dispose:Boolean

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

Returns
BitmapData
drawFace3D()method 
public override function drawFace3D(instance:DisplayObject3D, face3D:Face3D, graphics:Graphics, v0:Vertex2D, v1:Vertex2D, v2:Vertex2D):int

drawFace3D

Parameters
instance:DisplayObject3D
 
face3D:Face3D
 
graphics:Graphics
 
v0:Vertex2D
 
v1:Vertex2D
 
v2:Vertex2D

Returns
int
extendBitmapEdges()method 
protected function extendBitmapEdges(bmp:BitmapData, originalWidth:Number, originalHeight:Number):voidParameters
bmp:BitmapData
 
originalWidth:Number
 
originalHeight:Number
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:Face3D, instance:DisplayObject3D = null):Matrix

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

Parameters
face3D:Face3D
 
instance:DisplayObject3D (default = null)

Returns
Matrix