Packageaway3d.core.filter
Classpublic class FogFilter
InheritanceFogFilter Inheritance Object
Implements IPrimitiveFilter

Adds fog layers to a view and provides automatic farfield filtering for primitives outside the furthest fog layers.


Public Properties
 PropertyDefined By
  material : ColorMaterial
Defines the material used by the fog layers.
FogFilter
  materials : Array
Defines an array of materials used by the fog layers (overrides material and subdivisions).
FogFilter
  maxZ : Number
Defines the maximum distance (end distance) of the fog layers.
FogFilter
  minZ : Number
Defines the minimum distance (start distance) of the fog layers.
FogFilter
  subdivisions : Number
Defines the maximum distance (end distance) of the fog layers.
FogFilter
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.
FogFilter
Public Methods
 MethodDefined By
  
FogFilter(init:Object = null)
Creates a new FogFilter object.
FogFilter
  
filter(renderer:Renderer):void
Applies the filter to the primitive array.
FogFilter
  
toString():String
Used to trace the values of a filter.
FogFilter
  
updateMaterialColor(color:uint):void
Allows color change at runtime of the filter
FogFilter
Property Detail
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.

materialproperty 
material:ColorMaterial

Defines the material used by the fog layers.


Implementation
    public function get material():ColorMaterial
    public function set material(value:ColorMaterial):void
materialsproperty 
materials:Array

Defines an array of materials used by the fog layers (overrides material and subdivisions).


Implementation
    public function get materials():Array
    public function set materials(value:Array):void
maxZproperty 
maxZ:Number

Defines the maximum distance (end distance) of the fog layers.


Implementation
    public function get maxZ():Number
    public function set maxZ(value:Number):void
minZproperty 
minZ:Number

Defines the minimum distance (start distance) of the fog layers.


Implementation
    public function get minZ():Number
    public function set minZ(value:Number):void
subdivisionsproperty 
subdivisions:Number

Defines the maximum distance (end distance) of the fog layers.


Implementation
    public function get subdivisions():Number
    public function set subdivisions(value:Number):void
Constructor Detail
FogFilter()Constructor
public function FogFilter(init:Object = null)

Creates a new FogFilter object.

Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
####INIT####
Method Detail
filter()method
public function filter(renderer:Renderer):void

Applies the filter to the primitive array.

Parameters

renderer:Renderer — The primitives to be filtered.

toString()method 
public function toString():String

Used to trace the values of a filter.

Returns
String — A string representation of the filter object.
updateMaterialColor()method 
public function updateMaterialColor(color:uint):void

Allows color change at runtime of the filter

Parameters

color:uint — The new color for the filter





Tue Jun 7 2011, 11:27 PM +01:00