SSAOFilter (jMonkeyEngine3)

java.lang.Object
- com.jme3.post.Filter
- - com.jme3.post.ssao.SSAOFilter

All Implemented Interfaces:

Savable
```
public class SSAOFilter
extends Filter
```
SSAO stands for screen space ambient occlusion It's a technique that fakes ambient lighting by computing shadows that nearby objects would cast on each other. under the effect of an ambient light more info on this in this blog post http://jmonkeyengine.org/2010/08/16/screen-space-ambient-occlusion-for-jmonkeyengine-3-0/

Nested Class Summary
- Nested classes/interfaces inherited from class com.jme3.post.Filter
  Filter.Pass

Field Summary
- Fields inherited from class com.jme3.post.Filter
  defaultPass, enabled, material, postRenderPasses, processor

Constructor Summary

Constructors
Constructor and Description
`SSAOFilter()` Create a Screen Space Ambient Occlusion Filter
`SSAOFilter(float sampleRadius, float intensity, float scale, float bias)` Create a Screen Space Ambient Occlusion Filter

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cleanUpFilter(Renderer r)` override this method if you have some cleanup to do
`float`	`getBias()` Return the bias see `setBias(float bias)`
`float`	`getIntensity()` returns the ambient occlusion intensity
`protected Material`	`getMaterial()` Must return the material used for this filter.
`float`	`getSampleRadius()` returns the sample radius see {link setSampleRadius(float sampleRadius)}
`float`	`getScale()` returns the scale see `setScale(float scale)`
`protected void`	`initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h)` Initialization of filter subclasses.
`boolean`	`isApproximateNormals()`
`protected boolean`	`isRequiresDepthTexture()` Override this method and return true if your Filter needs the depth texture
`boolean`	`isUseAo()` debugging only , will be removed
`boolean`	`isUseOnlyAo()` debugging only , will be removed
`protected void`	`postQueue(RenderQueue queue)` Override this method if you want to make a pre pass, before the actual rendering of the frame
`void`	`read(JmeImporter im)` Override this method if you want to load extra properties when the filter is loaded else only basic properties of the filter will be loaded This method should always begin by super.read(im);
`void`	`setApproximateNormals(boolean approximateNormals)`
`void`	`setBias(float bias)` Sets the width of the occlusion cone considered by the occludee default is 0.1f
`void`	`setIntensity(float intensity)` Sets the Ambient occlusion intensity default is 1.5
`void`	`setSampleRadius(float sampleRadius)` Sets the radius of the area where random samples will be picked default 5.1f
`void`	`setScale(float scale)` Returns the distance between occluders and occludee.
`void`	`setUseAo(boolean useAo)` debugging only , will be removed
`void`	`setUseOnlyAo(boolean useOnlyAo)` debugging only , will be removed
`void`	`write(JmeExporter ex)` Override this method if you want to save extra properties when the filter is saved else only basic properties of the filter will be saved This method should always begin by super.write(ex);

Methods inherited from class com.jme3.post.Filter
cleanup, getDefaultPassDepthFormat, getDefaultPassTextureFormat, getName, getPostRenderPasses, getRenderedTexture, getRenderFrameBuffer, init, isEnabled, isRequiresBilinear, isRequiresSceneTexture, postFilter, postFrame, preFrame, setDepthTexture, setEnabled, setName, setProcessor, setRenderedTexture, setRenderFrameBuffer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SSAOFilter
```
public SSAOFilter()
```
    Create a Screen Space Ambient Occlusion Filter
  - SSAOFilter
```
public SSAOFilter(float sampleRadius,
                  float intensity,
                  float scale,
                  float bias)
```
    Create a Screen Space Ambient Occlusion Filter
    
    Parameters:
    
    sampleRadius - The radius of the area where random samples will be picked. default 5.1f
    
    intensity - intensity of the resulting AO. default 1.2f
    
    scale - distance between occluders and occludee. default 0.2f
    
    bias - the width of the occlusion cone considered by the occludee. default 0.1f
- Method Detail
  - isRequiresDepthTexture
```
protected boolean isRequiresDepthTexture()
```
    Description copied from class: Filter
    
    Override this method and return true if your Filter needs the depth texture
    
    Overrides:
    
    isRequiresDepthTexture in class Filter
    
    Returns:
    
    true if your Filter need the depth texture
  - postQueue
```
protected void postQueue(RenderQueue queue)
```
    Description copied from class: Filter
    
    Override this method if you want to make a pre pass, before the actual rendering of the frame
    
    Overrides:
    
    postQueue in class Filter
    
    Parameters:
    
    queue - the RenderQueue
  - getMaterial
```
protected Material getMaterial()
```
    Description copied from class: Filter
    
    Must return the material used for this filter. this method is called every frame.
    
    Specified by:
    
    getMaterial in class Filter
    
    Returns:
    
    the material used for this filter.
  - initFilter
```
protected void initFilter(AssetManager manager,
                          RenderManager renderManager,
                          ViewPort vp,
                          int w,
                          int h)
```
    Description copied from class: Filter
    
    Initialization of filter subclasses. This method is called once when the filter is added to the FilterPostProcessor It should contain Material initializations and extra passes initialization
    
    Specified by:
    
    initFilter in class Filter
    
    Parameters:
    
    manager - the assetManager
    
    renderManager - the renderManager
    
    vp - the viewPort where this filter is rendered
    
    w - the width of the filter
    
    h - the height of the filter
  - cleanUpFilter
```
protected void cleanUpFilter(Renderer r)
```
    Description copied from class: Filter
    
    override this method if you have some cleanup to do
    
    Overrides:
    
    cleanUpFilter in class Filter
    
    Parameters:
    
    r - the renderer
  - getBias
```
public float getBias()
```
    Return the bias
    see setBias(float bias)
    
    Returns:
    
    bias
  - setBias
```
public void setBias(float bias)
```
    Sets the width of the occlusion cone considered by the occludee default is 0.1f
    
    Parameters:
    
    bias - the desired width (default=0.1)
  - getIntensity
```
public float getIntensity()
```
    returns the ambient occlusion intensity
    
    Returns:
    
    intensity
  - setIntensity
```
public void setIntensity(float intensity)
```
    Sets the Ambient occlusion intensity default is 1.5
    
    Parameters:
    
    intensity - the desired intensity (default=1.5)
  - getSampleRadius
```
public float getSampleRadius()
```
    returns the sample radius
    see {link setSampleRadius(float sampleRadius)}
    
    Returns:
    
    the sample radius
  - setSampleRadius
```
public void setSampleRadius(float sampleRadius)
```
    Sets the radius of the area where random samples will be picked default 5.1f
    
    Parameters:
    
    sampleRadius - the desired radius (default=5.1)
  - getScale
```
public float getScale()
```
    returns the scale
    see setScale(float scale)
    
    Returns:
    
    scale
  - setScale
```
public void setScale(float scale)
```
    Returns the distance between occluders and occludee. default 0.2f
    
    Parameters:
    
    scale - the desired distance (default=0.2)
  - isUseAo
```
public boolean isUseAo()
```
    debugging only , will be removed
    
    Returns:
    
    true if using ambient occlusion
  - setUseAo
```
public void setUseAo(boolean useAo)
```
    debugging only , will be removed
    
    Parameters:
    
    useAo - true to enable, false to disable (default=true)
  - setApproximateNormals
```
public void setApproximateNormals(boolean approximateNormals)
```
  - isApproximateNormals
```
public boolean isApproximateNormals()
```
  - isUseOnlyAo
```
public boolean isUseOnlyAo()
```
    debugging only , will be removed
    
    Returns:
    
    useOnlyAo
  - setUseOnlyAo
```
public void setUseOnlyAo(boolean useOnlyAo)
```
    debugging only , will be removed
    
    Parameters:
    
    useOnlyAo - true to enable, false to disable (default=false)
  - write
```
public void write(JmeExporter ex)
           throws java.io.IOException
```
    Description copied from class: Filter
    
    Override this method if you want to save extra properties when the filter is saved else only basic properties of the filter will be saved This method should always begin by super.write(ex);
    
    Specified by:
    
    write in interface Savable
    
    Overrides:
    
    write in class Filter
    
    Parameters:
    
    ex - the exporter (not null)
    
    Throws:
    
    java.io.IOException - from the exporter
  - read
```
public void read(JmeImporter im)
          throws java.io.IOException
```
    Description copied from class: Filter
    
    Override this method if you want to load extra properties when the filter is loaded else only basic properties of the filter will be loaded This method should always begin by super.read(im);
    
    Specified by:
    
    read in interface Savable
    
    Overrides:
    
    read in class Filter
    
    Throws:
    
    java.io.IOException

Class SSAOFilter

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.post.Filter

Field Summary

Fields inherited from class com.jme3.post.Filter

Constructor Summary

Method Summary

Methods inherited from class com.jme3.post.Filter

Methods inherited from class java.lang.Object

Constructor Detail

SSAOFilter

SSAOFilter

Method Detail

isRequiresDepthTexture

postQueue

getMaterial

initFilter

cleanUpFilter

getBias

setBias

getIntensity

setIntensity

getSampleRadius

setSampleRadius

getScale

setScale

isUseAo

setUseAo

setApproximateNormals

isApproximateNormals

isUseOnlyAo

setUseOnlyAo

write

read