com.jme3.post.filters

Class RadialBlurFilter

java.lang.Object

com.jme3.post.Filter

com.jme3.post.filters.RadialBlurFilter

All Implemented Interfaces:

Savable

public class RadialBlurFilter
extends Filter

Radially blurs the scene from the center of it

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
RadialBlurFilter() Creates a RadialBlurFilter
RadialBlurFilter(float sampleDist, float sampleStrength) Creates a RadialBlurFilter

Method Summary

Modifier and Type	Method and Description
protected Material	getMaterial() Must return the material used for this filter.
float	getSampleDist() Deprecated. use getSampleDistance()
float	getSampleDistance() return the sample distance
float	getSampleStrength() Returns the sample Strength
protected void	initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h) Initialization of filter subclasses.
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	setSampleDist(float sampleDist) Deprecated. use setSampleDistance(float sampleDist)
void	setSampleDistance(float sampleDist) sets the samples distances default is 1
void	setSampleStrength(float sampleStrength) sets the sample strength default is 2.2
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, cleanUpFilter, getDefaultPassDepthFormat, getDefaultPassTextureFormat, getName, getPostRenderPasses, getRenderedTexture, getRenderFrameBuffer, init, isEnabled, isRequiresBilinear, isRequiresDepthTexture, isRequiresSceneTexture, postFilter, postFrame, postQueue, 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

RadialBlurFilter

public RadialBlurFilter()

Creates a RadialBlurFilter

RadialBlurFilter

public RadialBlurFilter(float sampleDist,
                        float sampleStrength)

Creates a RadialBlurFilter

Parameters:

sampleDist - the distance between samples

sampleStrength - the strength of each sample

Method Detail

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.

getSampleDistance

public float getSampleDistance()

return the sample distance

Returns:

the distance

setSampleDistance

public void setSampleDistance(float sampleDist)

sets the samples distances default is 1

Parameters:

sampleDist - the desired distance (default=1)

getSampleDist

@Deprecated
public float getSampleDist()

Deprecated. use getSampleDistance()

Returns:

the distance

setSampleDist

@Deprecated
public void setSampleDist(float sampleDist)

Deprecated. use setSampleDistance(float sampleDist)

Parameters:

sampleDist - the desired distance (default=1)

getSampleStrength

public float getSampleStrength()

Returns the sample Strength

Returns:

the strength value

setSampleStrength

public void setSampleStrength(float sampleStrength)

sets the sample strength default is 2.2

Parameters:

sampleStrength - the desired strength (default=2.2)

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

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