Packageorg.papervision3d.materials
Classpublic class MovieMaterial
InheritanceMovieMaterial Inheritance BitmapMaterial Inheritance TriangleMaterial Inheritance MaterialObject3D Inheritance flash.events.EventDispatcher
ImplementsITriangleDrawer, IUpdateAfterMaterial, IUpdateBeforeMaterial
SubclassesMovieAssetMaterial, VideoStreamMaterial

The MovieMaterial class creates a texture from an existing MovieClip instance.

The texture can be animated and/or transparent. Current scale and color values of the MovieClip instance will be used. Rotation will be discarded.

Materials collects data about how objects appear when rendered.



Public Properties
 PropertyDefined by
  allowAutoResize : Boolean = false
When updateBitmap() is called on an animated material, it looks to handle a change in size on the texture.
MovieMaterial
  animated : Boolean
A Boolean value that determines whether the texture is animated.
MovieMaterial
 InheritedAUTO_MIP_MAPPING : Boolean = false
[static] Indicates if mip mapping is forced.
BitmapMaterial
 Inheritedbaked : Boolean = false
A Boolean value that determines whether the texture is cached, i.e.
MaterialObject3D
 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
 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
 InheritedminimumRenderSize : Number = 4
BitmapMaterial
 InheritedMIP_MAP_DEPTH : Number = 8
[static] Levels of mip mapping to force.
BitmapMaterial
  movie : DisplayObject
The MovieClip that is used as a texture.
MovieMaterial
  movieTransparent : Boolean
A Boolean value that determines whether the MovieClip is transparent.
MovieMaterial
 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
 InheritedpixelPrecision : int
BitmapMaterial
 Inheritedprecise : Boolean
BitmapMaterial
 Inheritedprecision : int
BitmapMaterial
 InheritedprecisionMode : int
Precision mode indicates how triangles are created for precise texture render.
BitmapMaterial
  rect : Rectangle
Rectangle object that defines the area of the source object to draw.
MovieMaterial
 Inheritedsmooth : Boolean = false
A Boolean value that determines whether the BitmapData texture is smoothed when rendered.
MaterialObject3D
  texture : Object
A texture object.
MovieMaterial
 Inheritedtiled : Boolean = false
A Boolean value that determines whether the texture is tiled when rendered.
MaterialObject3D
 InheriteduvMatrices : Dictionary
BitmapMaterial
 InheritedwidthOffset : Number = 0
Holds the original size of the bitmap before it was resized by Automip mapping
MaterialObject3D
Protected Properties
 PropertyDefined by
 Inheritedax : Number
BitmapMaterial
 Inheriteday : Number
BitmapMaterial
 Inheritedaz : Number
BitmapMaterial
 Inheritedbx : Number
BitmapMaterial
 Inheritedby : Number
BitmapMaterial
 Inheritedbz : Number
BitmapMaterial
 InheritedcullRect : Rectangle
BitmapMaterial
 Inheritedcx : Number
BitmapMaterial
 Inheritedcy : Number
BitmapMaterial
 Inheritedcz : Number
BitmapMaterial
 Inheriteddabx : Number
BitmapMaterial
 Inheriteddaby : Number
BitmapMaterial
 Inheriteddbcx : Number
BitmapMaterial
 Inheriteddbcy : Number
BitmapMaterial
 Inheriteddcax : Number
BitmapMaterial
 Inheriteddcay : Number
BitmapMaterial
 Inheriteddmax : Number
BitmapMaterial
 Inheriteddsab : Number
BitmapMaterial
 Inheriteddsbc : Number
BitmapMaterial
 Inheriteddsca : Number
BitmapMaterial
 Inheritedfaz : Number
BitmapMaterial
 Inheritedfbz : Number
BitmapMaterial
 Inheritedfcz : Number
BitmapMaterial
 Inheritedfocus : Number = 200
BitmapMaterial
 InheritedhitRect : Rectangle
[static]
BitmapMaterial
 Inheritedmabx : Number
BitmapMaterial
 Inheritedmaby : Number
BitmapMaterial
 Inheritedmabz : Number
BitmapMaterial
 Inheritedmbcx : Number
BitmapMaterial
 Inheritedmbcy : Number
BitmapMaterial
 Inheritedmbcz : Number
BitmapMaterial
 Inheritedmcax : Number
BitmapMaterial
 Inheritedmcay : Number
BitmapMaterial
 Inheritedmcaz : Number
BitmapMaterial
 Inheritedobjects : Dictionary
Inventory of registered objects
MaterialObject3D
 Inherited_perPixelPrecision : int = 8
BitmapMaterial
 Inherited_precise : Boolean
BitmapMaterial
 Inherited_precision : int = 8
BitmapMaterial
  recreateBitmapInSuper : Boolean
MovieMaterial
 InheritedrenderRecStorage : Array
BitmapMaterial
 InheritedtempPreBmp : BitmapData
BitmapMaterial
 InheritedtempPreGrp : Graphics
BitmapMaterial
 InheritedtempPreRSD : RenderSessionData
BitmapMaterial
 InheritedtempTriangleMatrix : Matrix
BitmapMaterial
 Inherited_texture : Object
BitmapMaterial
 Inherited_triMap : Matrix
[static]
BitmapMaterial
Public Methods
 MethodDefined by
  
MovieMaterial(movieAsset:DisplayObject = null, transparent:Boolean = false, animated:Boolean = false, precise:Boolean = false, rect:Rectangle = null)
The MovieMaterial class creates a texture from an existing MovieClip instance.
MovieMaterial
 Inherited
Creates a copy of the material.
BitmapMaterial
 Inherited
copy(material:MaterialObject3D):void
Copies the properties of a material.
BitmapMaterial
 Inherited
destroy():void
BitmapMaterial
  
drawBitmap():void
MovieMaterial
 Inherited
drawRT(rt:RenderTriangle, graphics:Graphics, renderSessionData:RenderSessionData):void
TriangleMaterial
  
drawTriangle(tri:RenderTriangle, graphics:Graphics, renderSessionData:RenderSessionData, altBitmap:BitmapData = null, altUV:Matrix = null):void
MovieMaterial
 Inherited
getObjectList():Dictionary
Returns a list of DisplayObject3D objects registered with the material.
MaterialObject3D
 Inherited
isUpdateable():Boolean
MaterialObject3D
 Inherited
registerObject(displayObject3D:DisplayObject3D):void
Registers the DisplayObject3D
MaterialObject3D
 Inherited
resetMapping():void
Resets the mapping coordinates.
BitmapMaterial
 Inherited
resetUVS():void
resetUVMatrices(); Resets the precalculated uvmatrices, so they can be recalculated
BitmapMaterial
  
setQuality(quality:String, stage:Stage, updateNow:Boolean = true):void
Specifies which rendering quality Flash Player uses when drawing the bitmap texture from the movie asset.
MovieMaterial
 Inherited
toString():String
Returns a string value representing the material properties in the specified BitmapMaterial object.
BitmapMaterial
 Inherited
transformUV(face3D:Triangle3D):Matrix
Applies the updated UV texture mapping values to the triangle.
BitmapMaterial
 Inherited
Applies the updated UV texture mapping values to the triangle.
BitmapMaterial
 Inherited
unregisterObject(displayObject3D:DisplayObject3D):void
MaterialObject3D
  
updateAfterRender(renderSessionData:RenderSessionData):void
MovieMaterial
  
updateBeforeRender(renderSessionData:RenderSessionData):void
Updates animated MovieClip bitmap.
MovieMaterial
 Inherited
updateBitmap():void
Updates the BitmapData bitmap from the given texture.
MaterialObject3D
Protected Methods
 MethodDefined by
 Inherited
correctBitmap(bitmap:BitmapData):BitmapData
BitmapMaterial
 Inherited
createBitmap(asset:BitmapData):BitmapData
BitmapMaterial
  
createBitmapFromSprite(asset:DisplayObject):BitmapData
MovieMaterial
 Inherited
BitmapMaterial
 Inherited
extendBitmapEdges(bmp:BitmapData, originalWidth:Number, originalHeight:Number):void
BitmapMaterial
  
initBitmap(asset:DisplayObject):void
MovieMaterial
 Inherited
renderRec(emMap:Matrix, v0:Vertex3DInstance, v1:Vertex3DInstance, v2:Vertex3DInstance, index:Number):void
BitmapMaterial
Protected Constants
 ConstantDefined by
 InheritedDEFAULT_FOCUS : Number = 200
[static]
BitmapMaterial
Property detail
allowAutoResizeproperty
public var allowAutoResize:Boolean = false

When updateBitmap() is called on an animated material, it looks to handle a change in size on the texture. This is true by default, but in certain situations, like drawing on an object, you wouldn't want the size to change

animatedproperty 
animated:Boolean  [read-write]

A Boolean value that determines whether the texture is animated. If set, the material must be included into the scene so the BitmapData texture can be updated when rendering. For performance reasons, the default value is false.

Implementation
    public function get animated():Boolean
    public function set animated(value:Boolean):void
movieproperty 
public var movie:DisplayObject

The MovieClip that is used as a texture.

movieTransparentproperty 
public var movieTransparent:Boolean

A Boolean value that determines whether the MovieClip is transparent. The default value is false, which is much faster.

recreateBitmapInSuperproperty 
protected var recreateBitmapInSuper:Boolean
rectproperty 
rect:Rectangle  [read-write]

Rectangle object that defines the area of the source object to draw. When present, this property defines bitmap size overriding allowAutoResize. If you do not supply this value, no clipping occurs and the entire source object is drawn.

Implementation
    public function get rect():Rectangle
    public function set rect(value:Rectangle):void
textureproperty 
texture:Object  [read-write]

A texture object.

Implementation
    public function get texture():Object
    public function set texture(value:Object):void
Constructor detail
MovieMaterial()constructor
public function MovieMaterial(movieAsset:DisplayObject = null, transparent:Boolean = false, animated:Boolean = false, precise:Boolean = false, rect:Rectangle = null)

The MovieMaterial class creates a texture from an existing MovieClip instance.

Parameters
movieAsset:DisplayObject (default = null) — A reference to an existing MovieClip loaded into memory or on stage
 
transparent:Boolean (default = false) — [optional] - If it's not transparent, the empty areas of the MovieClip will be of fill32 color. Default value is false.
 
animated:Boolean (default = false) — [optional] - a flag setting whether or not this material has animation. If set to true, it will be updated during each render loop
 
precise:Boolean (default = false)
 
rect:Rectangle (default = null)
Method detail
createBitmapFromSprite()method
protected function createBitmapFromSprite(asset:DisplayObject):BitmapData

Parameters
asset:DisplayObject

Returns
BitmapData
drawBitmap()method 
public function drawBitmap():void
drawTriangle()method 
public override function drawTriangle(tri:RenderTriangle, graphics:Graphics, renderSessionData:RenderSessionData, altBitmap:BitmapData = null, altUV:Matrix = null):voidParameters
tri:RenderTriangle
 
graphics:Graphics
 
renderSessionData:RenderSessionData
 
altBitmap:BitmapData (default = null)
 
altUV:Matrix (default = null)
initBitmap()method 
protected function initBitmap(asset:DisplayObject):voidParameters
asset:DisplayObject
setQuality()method 
public function setQuality(quality:String, stage:Stage, updateNow:Boolean = true):void

Specifies which rendering quality Flash Player uses when drawing the bitmap texture from the movie asset. If not set, bitmaps are drawn using the current stage quality setting.

Parameters
quality:String
 
stage:Stage
 
updateNow:Boolean (default = true)
updateAfterRender()method 
public function updateAfterRender(renderSessionData:RenderSessionData):voidParameters
renderSessionData:RenderSessionData
updateBeforeRender()method 
public function updateBeforeRender(renderSessionData:RenderSessionData):void

Updates animated MovieClip bitmap. Draws the current MovieClip image onto bitmap.

Parameters
renderSessionData:RenderSessionData