Packageaway3d.materials.shaders
Classpublic class EnviroShader
InheritanceEnviroShader Inheritance AbstractShader Inheritance flash.events.EventDispatcher
SubclassesEnviroColorMaterial

Shader class for environment lighting.

Public Properties
 PropertyDefined by
  bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the shader environment map.
EnviroShader
 InheritedblendMode : String
Defines a blendMode value for the shader bitmap.
AbstractShader
 Inheriteddebug : Boolean
Determines if faces with the shader applied are drawn with outlines
AbstractShader
  height : Number
[read-only] Returns the width of the bitmapData being used as the shader environment map.
EnviroShader
 Inheritedid : int
Unique identifier
AbstractShader
  mode : String
Setting for possible mapping methods.
EnviroShader
  reflectiveness : Number
Coefficient for the reflectiveness of the environment map.
EnviroShader
 Inheritedsmooth : Boolean
Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen
AbstractShader
 Inheritedvisible : Boolean
Indicates whether the material is visible
AbstractShader
  width : Number
[read-only] Returns the height of the bitmapData being used as the shader environment map.
EnviroShader
Protected Properties
 PropertyDefined by
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
AbstractShader
Public Methods
 MethodDefined by
  
EnviroShader
(bitmap:BitmapData, init:Object = null)
Creates a new EnviroShader object.
EnviroShader
 Inherited
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
AbstractShader
 Inherited
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
AbstractShader
 Inherited
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
AbstractShader
 Inherited
renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO
Renders a bitmapData surface object for the speficied face.
AbstractShader
  
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int
Renders a material layer for the specified triangle.
EnviroShader
  
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
EnviroShader
Protected Methods
 MethodDefined by
  
clearFaces(source:Object3D, view:View3D):void
EnviroShader
  
getMapping(source:Mesh, face:Face):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
EnviroShader
  
Renders the shader to the specified face.
EnviroShader
Property detail
bitmapproperty
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the shader environment map.

Implementation
    public function get bitmap():BitmapData
heightproperty 
height:Number  [read-only]

Returns the width of the bitmapData being used as the shader environment map.

Implementation
    public function get height():Number
modeproperty 
public var mode:String

Setting for possible mapping methods.

reflectivenessproperty 
reflectiveness:Number  [read-write]

Coefficient for the reflectiveness of the environment map.

Implementation
    public function get reflectiveness():Number
    public function set reflectiveness(value:Number):void
widthproperty 
width:Number  [read-only]

Returns the height of the bitmapData being used as the shader environment map.

Implementation
    public function get width():Number
Constructor detail
EnviroShader()constructor
public function EnviroShader(bitmap:BitmapData, init:Object = null)Parameters
bitmap:BitmapData — The bitmapData object to be used as the material's environment map.
 
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 mode:String (default = "linear")
 reflectiveness:Number (default = 0.5, min:0, max:1)
Method detail
clearFaces()method
protected function clearFaces(source:Object3D, view:View3D):void

Parameters
source:Object3D
 
view:View3D
getMapping()method 
protected function getMapping(source:Mesh, face:Face):Matrix

Calculates the mapping matrix required to draw the triangle texture to screen.

Parameters
source:Mesh — The source object of the material.
 
face:Face — The face object of the material.

Returns
Matrix — The required matrix object.
renderLayer()method 
public override function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int

Renders a material layer for the specified triangle.

Parameters
tri:DrawTriangle — The drawtriangle used for render information.
 
layer:Sprite — The parent layer into which the triangle is drawn.
 
level:int — Defines the sprite level for the layer.

Returns
int
renderShader()method 
protected override function renderShader(tri:DrawTriangle):void

Renders the shader to the specified face.

Parameters
tri:DrawTriangle — The face object being rendered.
updateMaterial()method 
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.EnviroShader'

Code examples

Comments