Class FadeFilter

java.lang.Object
com.jme3.post.Filter
com.jme3.post.filters.FadeFilter
All Implemented Interfaces:
Savable

public class FadeFilter extends Filter
Fade Filter allows you to make an animated fade effect on a scene.
See Also:
  • Constructor Details

    • 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 Details

    • 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
    • preFrame

      protected void preFrame(float tpf)
      Description copied from class: Filter
      Override this method if you want to modify parameters according to tpf before the rendering of the frame. This is useful for animated filters Also it can be the place to render pre passes
      Overrides:
      preFrame in class Filter
      Parameters:
      tpf - the time used to render the previous frame
    • 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(JmeExporter ex) throws 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:
      IOException - from the exporter
    • read

      public void read(JmeImporter im) throws 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:
      IOException
    • getValue

      public float getValue()
      Returns the current fade value. Can be used to check whether fade is complete (e.g. value=1).
      Returns:
      the fractional progress (≥0, ≤1)
    • setValue

      public void setValue(float value)
      Sets the fade value. Can be used to force all black or all scene.
      Parameters:
      value - the desired value (default=1)