Packageaway3d.materials
Classpublic class BitmapMaterial
InheritanceBitmapMaterial Inheritance DefaultMaterialBase Inheritance MaterialBase
SubclassesAnimatedBitmapMaterial, BitmapFileMaterial, VideoMaterial

BitmapMaterial is a material that uses a BitmapData texture as the surface's diffuse colour.

Public Properties
 PropertyDefined by
  alpha : Number
The alpha of the surface.
BitmapMaterial
 Inheritedambient : Number
The strength of the ambient reflection.
DefaultMaterialBase
 InheritedambientColor : uint
The colour of the ambient reflection.
DefaultMaterialBase
 InheritedambientMethod : BasicAmbientMethod
The method to perform diffuse shading.
DefaultMaterialBase
  bitmapData : BitmapData
The BitmapData object to use as the texture.
BitmapMaterial
 InheritedblendMode : String
The blend mode to use when drawing this renderable.
MaterialBase
 InheritedbothSides : Boolean
Defines whether or not the material should perform backface culling.
MaterialBase
 InheritedcolorTransform : ColorTransform
The ColorTransform object to transform the colour of the material with.
DefaultMaterialBase
 InheriteddiffuseMethod : BasicDiffuseMethod
The method to perform diffuse shading.
DefaultMaterialBase
 Inheritedextra : Object
An object to contain any extra data
MaterialBase
 Inheritedgloss : Number
The sharpness of the specular highlight.
DefaultMaterialBase
 Inheritedlights : Array
MaterialBase
 InheritedmaterialNamespace : String
The namespace of the material, used by the MaterialLibrary.
MaterialBase
 Inheritedmipmap : Boolean
DefaultMaterialBase
 Inheritedname : String
The name of the material.
MaterialBase
 InheritednormalMap : BitmapData
The tangent space normal map to influence the direction of the surface for each texel.
DefaultMaterialBase
 Inheritedrepeat : Boolean
Indicates whether or not any used textures should be tiled.
MaterialBase
  requiresBlending : Boolean
[read-only]
BitmapMaterial
 InheritedshadowMethod : ShadingMethodBase
The method to perform diffuse shading.
DefaultMaterialBase
 Inheritedsmooth : Boolean
Indicates whether or not any used textures should use smoothing.
MaterialBase
 Inheritedspecular : Number
The overall strength of the specular reflection.
DefaultMaterialBase
 InheritedspecularColor : uint
The colour of the specular reflection.
DefaultMaterialBase
 InheritedspecularMap : BitmapData
A specular map that defines the strength of specular reflections for each texel.
DefaultMaterialBase
 InheritedspecularMethod : BasicSpecularMethod
The method to perform specular shading.
DefaultMaterialBase
  transparent : Boolean
Indicate whether or not the BitmapData contains transparency.
BitmapMaterial
 InheriteduniqueId : uint
The unique id assigned to the material by the MaterialLibrary.
MaterialBase
Protected Properties
 PropertyDefined by
 Inherited_mipmap : Boolean
MaterialBase
 Inherited_numPasses : uint
MaterialBase
 Inherited_screenPass : DefaultScreenPass
DefaultMaterialBase
Public Methods
 MethodDefined by
  
BitmapMaterial
(bitmapData:BitmapData = null, smooth:Boolean = true, repeat:Boolean = false, mipmap:Boolean = true)
Creates a new BitmapMaterial.
BitmapMaterial
 Inherited
addMethod(method:ShadingMethodBase):void
DefaultMaterialBase
 Inherited
addMethodAt(method:ShadingMethodBase, index:int):void
DefaultMaterialBase
  
dispose(deep:Boolean):void
BitmapMaterial
 Inherited
isBitmapDataValid(bitmapData:BitmapData, id:uint = 0):Boolean
DefaultMaterialBase
 Inherited
removeMethod(method:ShadingMethodBase):void
DefaultMaterialBase
 Inherited
setNameAndSpace(name:String, materialNameSpace:String):void
Sets the materials name and namespace.
MaterialBase
  
updateTexture():void
Triggers an update of the texture, to be used when the contents of the BitmapData has changed.
BitmapMaterial
Protected Methods
 MethodDefined by
 Inherited
addPass(pass:MaterialPassBase):void
Adds a pass to the material
MaterialBase
 Inherited
clearPasses():void
Clears all passes in the material.
MaterialBase
Property detail
alphaproperty
alpha:Number  [read-write]

The alpha of the surface.

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
bitmapDataproperty 
bitmapData:BitmapData  [read-write]

The BitmapData object to use as the texture.

Implementation
    public function get bitmapData():BitmapData
    public function set bitmapData(value:BitmapData):void
requiresBlendingproperty 
requiresBlending:Boolean  [read-only]Implementation
    public function get requiresBlending():Boolean
transparentproperty 
transparent:Boolean  [read-write]

Indicate whether or not the BitmapData contains transparency.

Implementation
    public function get transparent():Boolean
    public function set transparent(value:Boolean):void
Constructor detail
BitmapMaterial()constructor
public function BitmapMaterial(bitmapData:BitmapData = null, smooth:Boolean = true, repeat:Boolean = false, mipmap:Boolean = true)Parameters
bitmapData:BitmapData (default = null) — The BitmapData object to use as the texture.
 
smooth:Boolean (default = true) — Indicates whether or not the texture should use smoothing.
 
repeat:Boolean (default = false) — Indicates whether or not the texture should be tiled.
 
mipmap:Boolean (default = true) — Indicates whether or not the texture should use mipmapping.
Init Parameters
Method detail
dispose()method
public override function dispose(deep:Boolean):void

Parameters
deep:Boolean
updateTexture()method 
public function updateTexture():void

Triggers an update of the texture, to be used when the contents of the BitmapData has changed.

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

Code examples

Comments