|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jme3.post.Filter
com.jme3.post.filters.FadeFilter
public class FadeFilter
Fade Filter allows you to make an animated fade effect on a scene.
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 | |
---|---|
FadeFilter()
Creates a FadeFilter |
|
FadeFilter(float duration)
Creates a FadeFilter with the given duration |
Method Summary | |
---|---|
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 Material |
getMaterial()
Must return the material used for this filter. |
float |
getValue()
return the current value of the fading can be used to chack if fade is complete (eg value=1) |
protected void |
initFilter(AssetManager manager,
RenderManager renderManager,
ViewPort vp,
int w,
int h)
Initialization of sub classes filters This method is called once when the filter is added to the FilterPostProcessor It should contain Material initializations and extra passes initialization |
void |
pause()
|
protected void |
preFrame(float tpf)
Override this method if you want to modify parameters according to tpf before the 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 |
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(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, isRequiresDepthTexture, isRequiresSceneTexture, 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 |
---|
public FadeFilter()
public FadeFilter(float duration)
duration
- Method Detail |
---|
protected Material getMaterial()
Filter
getMaterial
in class Filter
protected void initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h)
Filter
initFilter
in class Filter
manager
- the assetManagerrenderManager
- the renderManagervp
- the viewPort where this filter is renderedw
- the width of the filterh
- the height of the filterprotected void preFrame(float tpf)
Filter
preFrame
in class Filter
tpf
- the time used to render the previous framepublic float getDuration()
public void setDuration(float duration)
duration
- public void fadeIn()
public void fadeOut()
public void pause()
public void write(JmeExporter ex) throws java.io.IOException
Filter
write
in interface Savable
write
in class Filter
java.io.IOException
public void read(JmeImporter im) throws java.io.IOException
Filter
read
in interface Savable
read
in class Filter
java.io.IOException
public float getValue()
public void setValue(float value)
value
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |