Package heronarts.lx.pattern.image

Class SlideshowPattern

java.lang.Object
heronarts.lx.LXComponent
heronarts.lx.LXModulatorComponent
heronarts.lx.LXModelComponent
heronarts.lx.LXLayeredComponent
heronarts.lx.LXDeviceComponent
heronarts.lx.pattern.LXPattern
heronarts.lx.pattern.image.SlideshowPattern
All Implemented Interfaces:
LXEffect.Container, LXComponent.Renamable, LXLoopTask, LXPath, LXPresetComponent, LXSerializable, LXMidiListener, LXModulationContainer, LXOscComponent, LXParameterListener
@LXCategory("Image") @Description("Animate transitions between a set of 2D images") public class SlideshowPattern extends LXPattern

  • Field Details

  • Constructor Details

    • SlideshowPattern

      public SlideshowPattern(LX lx)

  • Method Details

    • getActiveImage

      public SlideshowPattern.Image getActiveImage()

    • getNextImage

      public SlideshowPattern.Image getNextImage()

    • getTargetImage

      public SlideshowPattern.Image getTargetImage()

    • goImage

      public SlideshowPattern goImage(int index)

    • goNextImage

      public SlideshowPattern goNextImage()

    • goRandomImage

      public final SlideshowPattern goRandomImage()

    • getFocusedImage

      public SlideshowPattern.Image getFocusedImage()

    • addImage

      public SlideshowPattern.Image addImage()

    • addImage

      public SlideshowPattern.Image addImage(int index)

    • addImage

      public SlideshowPattern.Image addImage(int index, JsonObject imageObj)

    • removeImage

      public void removeImage(SlideshowPattern.Image image)

    • moveImage

      public void moveImage(SlideshowPattern.Image image, int index)

    • addListener

      public void addListener(SlideshowPattern.Listener listener)

    • removeListener

      public void removeListener(SlideshowPattern.Listener listener)

    • getAutoCycleProgress

      public double getAutoCycleProgress()
      Return progress towards making a cycle
      Returns:
      amount of progress towards the next cycle

    • getTransitionProgress

      public double getTransitionProgress()
      Return progress through a transition
      Returns:
      amount of progress thru current transition

    • run

      protected void run(double deltaMs)
      Description copied from class: LXPattern
      Main pattern loop function. Invoked in a render loop. Subclasses must implement this function.
      Specified by:
      run in class LXPattern
      Parameters:
      deltaMs - Number of milliseconds elapsed since last invocation

    • save

      public void save(LX lx, JsonObject obj)
      Description copied from class: LXComponent
      Serializes the LX component. By default, all internal and user-facing parameters are serialized, as well as any explicitly registered child components. Note that child arrays are not serialized, or any other dynamic components. Subclasses may override to perform more saving, and are expected to call super.save(lx, obj) at the appropriate time.
      Specified by:
      save in interface LXSerializable
      Overrides:
      save in class LXPattern
      Parameters:
      lx - LX instance
      obj - Object to serialize into

    • load

      public void load(LX lx, JsonObject obj)
      Description copied from class: LXComponent
      Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.
      Specified by:
      load in interface LXSerializable
      Overrides:
      load in class LXPattern
      Parameters:
      lx - LX instance
      obj - Object to deserialize

    • dispose

      public void dispose()
      Description copied from class: LXComponent
      Invoked when a component is being removed from the system and will no longer be used at all. This unregisters the component and should free up any resources and parameter listeners. Ideally after this method is called the object should be eligible for garbage collection. Subclasses are generally expected to override this method to handle their particular cleanup work. They should also generally call super.dispose() at the appropriate time to perform the basic cleanup, which may need to happen either before or after cleaning up other objects.
      Overrides:
      dispose in class LXPattern