Packageorg.papervision3d.core.proto
Classpublic class MaterialObject3D
InheritanceMaterialObject3D Inheritance flash.events.EventDispatcher
ImplementsITriangleDrawer
SubclassesLineMaterial, ParticleMaterial, TriangleMaterial

The MaterialObject3D class is the base class for all materials.

Materials collects data about how objects appear when rendered.

A material is data that you assign to objects or faces, so that they appear a certain way when rendered. Materials affect the line and fill colors.

Materials create greater realism in a scene. A material describes how an object reflects or transmits light.

You assign materials to individual objects or a selection of faces; a single object can contain different materials.

MaterialObject3D is an abstract base class; therefore, you cannot call MaterialObject3D directly.



Public Properties
 PropertyDefined by
  bitmap : BitmapData
A transparent or opaque BitmapData texture.
MaterialObject3D
  DEBUG : MaterialObject3D
[static][read-only]
MaterialObject3D
  DEBUG_COLOR : int = 0xFF00FF
[static] Color used for DEBUG material.
MaterialObject3D
  DEFAULT : MaterialObject3D
[static][read-only] Returns a MaterialObject3D object with the default magenta wireframe values.
MaterialObject3D
  DEFAULT_COLOR : int = 0x000000
[static] Color used for DEFAULT material.
MaterialObject3D
  doubleSided : Boolean
A Boolean value that indicates whether the faces are double sided.
MaterialObject3D
  fillAlpha : Number = 0
An 8-bit alpha value fill the faces with.
MaterialObject3D
  fillColor : Number
A RGB color value to fill the faces with.
MaterialObject3D
  heightOffset : Number = 0
Holds the original size of the bitmap before it was resized by Automip mapping
MaterialObject3D
  id : Number
[internal-use] [read-only] Unique id of this instance.
MaterialObject3D
  interactive : Boolean = false
Defines if this material will be interactive;
MaterialObject3D
  invisible : Boolean = false
A Boolean value that indicates whether the faces are invisible (not drawn).
MaterialObject3D
  lineAlpha : Number = 0
An 8-bit alpha value for the faces outline.
MaterialObject3D
  lineColor : Number
A RGB color value to draw the faces outline.
MaterialObject3D
  lineThickness : Number = 1
An value for the thickness of the faces line.
MaterialObject3D
  maxU : Number
Internal use
MaterialObject3D
  maxV : Number
Internal use
MaterialObject3D
  name : String
The name of the material.
MaterialObject3D
  oneSide : Boolean = true
A Boolean value that indicates whether the faces are single sided.
MaterialObject3D
  opposite : Boolean = false
A Boolean value that indicates whether the face is flipped.
MaterialObject3D
  smooth : Boolean = false
A Boolean value that determines whether the BitmapData texture is smoothed when rendered.
MaterialObject3D
  tiled : Boolean = false
A Boolean value that determines whether the texture is tiled when rendered.
MaterialObject3D
  widthOffset : Number = 0
Holds the original size of the bitmap before it was resized by Automip mapping
MaterialObject3D
Protected Properties
 PropertyDefined by
  objects : Dictionary
MaterialObject3D
Public Methods
 MethodDefined by
  
Creates a new MaterialObject3D object.
MaterialObject3D
  
Creates a copy of the material.
MaterialObject3D
  
copy(material:MaterialObject3D):void
Copies the properties of a material.
MaterialObject3D
  
destroy():void
MaterialObject3D
  
drawTriangle(face3D:Triangle3D, graphics:Graphics, renderSessionData:RenderSessionData, altBitmap:BitmapData = null, altUV:Matrix = null):void
drawTriangle(); Draws the triangle to screen.
MaterialObject3D
  
registerObject(displayObject3D:DisplayObject3D):void
MaterialObject3D
  
toString():String
Returns a string value representing the material properties.
MaterialObject3D
  
unregisterObject(displayObject3D:DisplayObject3D):void
MaterialObject3D
  
updateBitmap():void
Updates the BitmapData bitmap from the given texture.
MaterialObject3D
Property detail
bitmapproperty
public var bitmap:BitmapData

A transparent or opaque BitmapData texture.

DEBUGproperty 
DEBUG:MaterialObject3D  [read-only]Implementation
    public static function get DEBUG():MaterialObject3D
DEBUG_COLORproperty 
public static var DEBUG_COLOR:int = 0xFF00FF

Color used for DEBUG material.

DEFAULTproperty 
DEFAULT:MaterialObject3D  [read-only]

Returns a MaterialObject3D object with the default magenta wireframe values.

Implementation
    public static function get DEFAULT():MaterialObject3D
DEFAULT_COLORproperty 
public static var DEFAULT_COLOR:int = 0x000000

Color used for DEFAULT material.

doubleSidedproperty 
doubleSided:Boolean  [read-write]

A Boolean value that indicates whether the faces are double sided.

Implementation
    public function get doubleSided():Boolean
    public function set doubleSided(value:Boolean):void
fillAlphaproperty 
public var fillAlpha:Number = 0

An 8-bit alpha value fill the faces with. If this value is zero and no texture is provided or is undefined, a fill is not created.

fillColorproperty 
public var fillColor:Number

A RGB color value to fill the faces with. Only used if no texture is provided.

heightOffsetproperty 
public var heightOffset:Number = 0

Holds the original size of the bitmap before it was resized by Automip mapping

idproperty 
public var id:Number

[internal-use] [read-only] Unique id of this instance.

interactiveproperty 
public var interactive:Boolean = false

Defines if this material will be interactive;

invisibleproperty 
public var invisible:Boolean = false

A Boolean value that indicates whether the faces are invisible (not drawn).

lineAlphaproperty 
public var lineAlpha:Number = 0

An 8-bit alpha value for the faces outline. If zero, no outline is drawn.

lineColorproperty 
public var lineColor:Number

A RGB color value to draw the faces outline.

lineThicknessproperty 
public var lineThickness:Number = 1

An value for the thickness of the faces line.

maxUproperty 
public var maxU:Number

Internal use

maxVproperty 
public var maxV:Number

Internal use

nameproperty 
public var name:String

The name of the material.

objectsproperty 
protected var objects:Dictionary
oneSideproperty 
public var oneSide:Boolean = true

A Boolean value that indicates whether the faces are single sided. It has preference over doubleSided.

oppositeproperty 
public var opposite:Boolean = false

A Boolean value that indicates whether the face is flipped. Only used if doubleSided or not singeSided.

smoothproperty 
public var smooth:Boolean = false

A Boolean value that determines whether the BitmapData texture is smoothed when rendered.

tiledproperty 
public var tiled:Boolean = false

A Boolean value that determines whether the texture is tiled when rendered. Defaults to false.

widthOffsetproperty 
public var widthOffset:Number = 0

Holds the original size of the bitmap before it was resized by Automip mapping

Constructor detail
MaterialObject3D()constructor
public function MaterialObject3D()

Creates a new MaterialObject3D object.

Method detail
clone()method
public function clone():MaterialObject3D

Creates a copy of the material.

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

Copies the properties of a material.

Parameters
material:MaterialObject3D — Material to copy from.
destroy()method 
public function destroy():void
drawTriangle()method 
public function drawTriangle(face3D:Triangle3D, graphics:Graphics, renderSessionData:RenderSessionData, altBitmap:BitmapData = null, altUV:Matrix = null):void

drawTriangle(); Draws the triangle to screen.

Parameters
face3D:Triangle3D
 
graphics:Graphics
 
renderSessionData:RenderSessionData
 
altBitmap:BitmapData (default = null)
 
altUV:Matrix (default = null)
registerObject()method 
public function registerObject(displayObject3D:DisplayObject3D):voidParameters
displayObject3D:DisplayObject3D
toString()method 
public override function toString():String

Returns a string value representing the material properties.

Returns
String — A string.
unregisterObject()method 
public function unregisterObject(displayObject3D:DisplayObject3D):voidParameters
displayObject3D:DisplayObject3D
updateBitmap()method 
public function updateBitmap():void

Updates the BitmapData bitmap from the given texture. Draws the current MovieClip image onto bitmap.