Package nl.colorize.multimedialib.scene.effect

Class ParticleWipe

java.lang.Object
nl.colorize.multimedialib.scene.effect.ParticleWipe
All Implemented Interfaces:
Scene
public class ParticleWipe extends Object implements Scene
Uses a particle wipe effect that can be used for screen transitions. There are two modes: one where the particles slowly obscure the screen, and one where the particles slowly reveal the screen. Both effects would typically be used on either side of the transition.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final nl.colorize.util.ResourceFile
    CIRCLE
     
    static final nl.colorize.util.ResourceFile
    DIAMOND
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParticleWipe(Image particleImage, ColorRGB color, float duration, boolean reverse)
    Creates a new wipe transition based on the specified particle image.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    end(SceneContext context)
    Clean-up logic that is performed every time the scene ends.
    Container
    getContainer()
     
    boolean
    isCompleted()
    Indicates the scene has been completed and no longer wishes to receive frame updates.
    void
    start(SceneContext context)
    Initialization logic that should be performed when the scene is started.
    void
    update(SceneContext context, float deltaTime)
    Called during every frame update for as long as the scene is active.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DIAMOND

      public static final nl.colorize.util.ResourceFile DIAMOND

    • CIRCLE

      public static final nl.colorize.util.ResourceFile CIRCLE

  • Constructor Details

    • ParticleWipe

      public ParticleWipe(Image particleImage, ColorRGB color, float duration, boolean reverse)
      Creates a new wipe transition based on the specified particle image. If reverse is true, the transition will start fully obscured and will then play backwards, slowly revealing the stage.

  • Method Details

    • start

      public void start(SceneContext context)
      Description copied from interface: Scene
      Initialization logic that should be performed when the scene is started. Note that this method is called *every* time the scene is started, not just the first time.

      This method is optional, the default implementation does nothing.

      Specified by:
      start in interface Scene

    • update

      public void update(SceneContext context, float deltaTime)
      Description copied from interface: Scene
      Called during every frame update for as long as the scene is active. deltaTime indicates the elapsed time since the last frame, in seconds.
      Specified by:
      update in interface Scene

    • isCompleted

      public boolean isCompleted()
      Description copied from interface: Scene
      Indicates the scene has been completed and no longer wishes to receive frame updates.

      If this scene is the currently active scene, it might not actually end until a new scene is requested.

      If this scene is a completed sub-scene, meaning there is a parent scene which is still active, this sub-scene will end after the current frame.

      Specified by:
      isCompleted in interface Scene

    • end

      public void end(SceneContext context)
      Description copied from interface: Scene
      Clean-up logic that is performed every time the scene ends.

      This method is optional, the default implementation does nothing.

      Specified by:
      end in interface Scene

    • getContainer

      public Container getContainer()