Packageaway3d.materials.shaders
Classpublic class AbstractShader
InheritanceAbstractShader Inheritance flash.events.EventDispatcher
ImplementsILayerMaterial
SubclassesAmbientShader, DepthShader, DiffuseDot3Shader, DiffusePhongShader, EnviroShader, SpecularDot3Shader, SpecularPhongShader

Base class for shaders. Not intended for direct use - use one of the shading materials in the materials package.

Public Properties
 PropertyDefined by
  blendMode : String
Defines a blendMode value for the shader bitmap.
AbstractShader
  debug : Boolean
Determines if faces with the shader applied are drawn with outlines
AbstractShader
  id : int
[read-only] Unique identifier
AbstractShader
  smooth : Boolean
Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen
AbstractShader
  visible : Boolean
[read-only] Indicates whether the material is visible
AbstractShader
Protected Properties
 PropertyDefined by
  ini : 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
  
AbstractShader
(init:Object = null)
Creates a new AbstractShader object.
AbstractShader
  
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
AbstractShader
  
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
AbstractShader
  
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
AbstractShader
  
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.
AbstractShader
  
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
AbstractShader
Protected Methods
 MethodDefined by
  
Renders the shader to the specified face.
AbstractShader
Property detail
blendModeproperty
public var blendMode:String

Defines a blendMode value for the shader bitmap.

debugproperty 
public var debug:Boolean

Determines if faces with the shader applied are drawn with outlines

idproperty 
id:int  [read-only]

Unique identifier

Implementation
    public function get id():int
iniproperty 
protected var ini:Init

Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.

smoothproperty 
public var smooth:Boolean

Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen

visibleproperty 
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
Constructor detail
AbstractShader()constructor
public function AbstractShader(init:Object = null)Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 smooth:Boolean (default = false)
 debug:Boolean (default = false)
 blendMode:String (default = BlendMode.NORMAL)
Method detail
addOnMaterialUpdate()method
public function addOnMaterialUpdate(listener:Function):void

Default method for adding a materialupdated event listener

Parameters
listener:Function — The listener function
getFaceMaterialVO()method 
public function getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO

Parameters
faceVO:FaceVO
 
source:Object3D (default = null)
 
view:View3D (default = null)

Returns
FaceMaterialVO
removeOnMaterialUpdate()method 
public function removeOnMaterialUpdate(listener:Function):void

Default method for removing a materialupdated event listener

Parameters
listener:Function — The listener function
renderBitmapLayer()method 
public function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO

Renders a bitmapData surface object for the speficied face.

Parameters
tri:DrawTriangle — The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle — The rectangle object defining the bounds of the face in uv-space.
 
parentFaceMaterialVO:FaceMaterialVO — The value object of the preceeding surface.

Returns
FaceMaterialVO
renderLayer()method 
public 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 function renderShader(tri:DrawTriangle):void

Renders the shader to the specified face.

Parameters
tri:DrawTriangle — The face object being rendered.
updateMaterial()method 
public 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.AbstractShader'

Code examples

Comments