Packageaway3d.filters
Classpublic class DepthOfFieldFilter3D
InheritanceDepthOfFieldFilter3D Inheritance Filter3DBase Inheritance Object



Public Properties
 PropertyDefined By
  focusDistance : Number
The distance from the camera to the point that is in focus.
DepthOfFieldFilter3D
  focusTarget : ObjectContainer3D
An optional target ObjectContainer3D that will be used to auto-focus on.
DepthOfFieldFilter3D
  maxBlurX : uint
The maximum amount of horizontal blur.
DepthOfFieldFilter3D
  maxBlurY : uint
The maximum amount of vertical blur.
DepthOfFieldFilter3D
  range : Number
The distance between the focus point and the maximum amount of blur.
DepthOfFieldFilter3D
 InheritedrequireDepthRender : Boolean
[read-only]
Filter3DBase
  stepSize : int
The amount of pixels between each sample.
DepthOfFieldFilter3D
 Inheritedtasks : Vector.<Filter3DTaskBase>
[read-only]
Filter3DBase
 InheritedtextureHeight : int
Filter3DBase
 InheritedtextureWidth : int
Filter3DBase
Public Methods
 MethodDefined By
  
DepthOfFieldFilter3D(maxBlurX:uint = 3, maxBlurY:uint = 3, stepSize:int = -1)
Creates a new DepthOfFieldFilter3D object.
DepthOfFieldFilter3D
 Inherited
dispose():void
Filter3DBase
 Inherited
getMainInputTexture(stage3DProxy:Stage3DProxy):Texture
Filter3DBase
  
setRenderTargets(mainTarget:Texture, stage3DProxy:Stage3DProxy):void
[override]
DepthOfFieldFilter3D
  
update(stage:Stage3DProxy, camera:Camera3D):void
[override]
DepthOfFieldFilter3D
Protected Methods
 MethodDefined By
 Inherited
Filter3DBase
Property Detail
focusDistanceproperty
focusDistance:Number

The distance from the camera to the point that is in focus.


Implementation
    public function get focusDistance():Number
    public function set focusDistance(value:Number):void
focusTargetproperty 
focusTarget:ObjectContainer3D

An optional target ObjectContainer3D that will be used to auto-focus on.


Implementation
    public function get focusTarget():ObjectContainer3D
    public function set focusTarget(value:ObjectContainer3D):void
maxBlurXproperty 
maxBlurX:uint

The maximum amount of horizontal blur.


Implementation
    public function get maxBlurX():uint
    public function set maxBlurX(value:uint):void
maxBlurYproperty 
maxBlurY:uint

The maximum amount of vertical blur.


Implementation
    public function get maxBlurY():uint
    public function set maxBlurY(value:uint):void
rangeproperty 
range:Number

The distance between the focus point and the maximum amount of blur.


Implementation
    public function get range():Number
    public function set range(value:Number):void
stepSizeproperty 
stepSize:int

The amount of pixels between each sample.


Implementation
    public function get stepSize():int
    public function set stepSize(value:int):void
Constructor Detail
DepthOfFieldFilter3D()Constructor
public function DepthOfFieldFilter3D(maxBlurX:uint = 3, maxBlurY:uint = 3, stepSize:int = -1)

Creates a new DepthOfFieldFilter3D object.

Parameters
maxBlurX:uint (default = 3) — The maximum amount of horizontal blur to apply
 
maxBlurY:uint (default = 3) — The maximum amount of vertical blur to apply
 
stepSize:int (default = -1) — The distance between samples. Set to -1 to auto-detect with acceptable quality.
Method Detail
setRenderTargets()method
override public function setRenderTargets(mainTarget:Texture, stage3DProxy:Stage3DProxy):void

Parameters

mainTarget:Texture
 
stage3DProxy:Stage3DProxy

update()method 
override public function update(stage:Stage3DProxy, camera:Camera3D):void

Parameters

stage:Stage3DProxy
 
camera:Camera3D