com.jme3.post.filters

Class FadeFilter

java.lang.Object

com.jme3.post.Filter

com.jme3.post.filters.FadeFilter

All Implemented Interfaces:

com.jme3.export.Savable

public class FadeFilter
extends com.jme3.post.Filter

Fade Filter allows you to make an animated fade effect on a scene.

Author:

Rémy Bouquet aka Nehon implemented from boxjar implementation

See Also:

http://jmonkeyengine.org/groups/graphics/forum/topic/newbie-question-general-fade-inout-effect/#post-105559

Nested Class Summary

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

com.jme3.post.Filter.Pass

Field Summary

Fields inherited from class com.jme3.post.Filter

defaultPass, enabled, material, postRenderPasses, processor

Constructor Summary

Constructors

Constructor and Description
FadeFilter() Creates a FadeFilter
FadeFilter(float duration) Creates a FadeFilter with the given duration

Method Summary

Modifier and Type	Method and Description
void	fadeIn() fades the scene in (black to scene)
void	fadeOut() fades the scene out (scene to black)
float	getDuration() returns the duration of the effect
protected com.jme3.material.Material	getMaterial()
float	getValue() return the current value of the fading can be used to check if fade is complete (eg value=1)
protected void	initFilter(com.jme3.asset.AssetManager manager, com.jme3.renderer.RenderManager renderManager, com.jme3.renderer.ViewPort vp, int w, int h)
void	pause()
protected void	preFrame(float tpf)
void	read(com.jme3.export.JmeImporter im)
void	setDuration(float duration) Sets the duration of the filter default is 1 second
void	setValue(float value) sets the fade value can be used to force complete black or compete scene
void	write(com.jme3.export.JmeExporter 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, 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

FadeFilter

public FadeFilter()

Creates a FadeFilter

FadeFilter

public FadeFilter(float duration)

Creates a FadeFilter with the given duration

Parameters:

duration - the desired duration (in seconds, default=1)

Method Detail

getMaterial

protected com.jme3.material.Material getMaterial()

Specified by:

getMaterial in class com.jme3.post.Filter

initFilter

protected void initFilter(com.jme3.asset.AssetManager manager,
                          com.jme3.renderer.RenderManager renderManager,
                          com.jme3.renderer.ViewPort vp,
                          int w,
                          int h)

Specified by:

initFilter in class com.jme3.post.Filter

preFrame

protected void preFrame(float tpf)

Overrides:

preFrame in class com.jme3.post.Filter

getDuration

public float getDuration()

returns the duration of the effect

Returns:

the duration (in seconds)

setDuration

public void setDuration(float duration)

Sets the duration of the filter default is 1 second

Parameters:

duration - the desired duration (in seconds, default=1)

fadeIn

public void fadeIn()

fades the scene in (black to scene)

fadeOut

public void fadeOut()

fades the scene out (scene to black)

pause

public void pause()

write

public void write(com.jme3.export.JmeExporter ex)
           throws java.io.IOException

Specified by:

write in interface com.jme3.export.Savable

Overrides:

write in class com.jme3.post.Filter

Throws:

java.io.IOException

read

public void read(com.jme3.export.JmeImporter im)
          throws java.io.IOException

Specified by:

read in interface com.jme3.export.Savable

Overrides:

read in class com.jme3.post.Filter

Throws:

java.io.IOException

getValue

public float getValue()

return the current value of the fading can be used to check if fade is complete (eg value=1)

Returns:

the fractional progress (≥0, ≤1)

setValue

public void setValue(float value)

sets the fade value can be used to force complete black or compete scene

Parameters:

value - the desired value (default=1)