Package heronarts.lx.snapshot

Class LXSnapshot.View

java.lang.Object
heronarts.lx.snapshot.LXSnapshot.View
All Implemented Interfaces:
LXSerializable
Direct Known Subclasses:
LXSnapshot.ActivePatternView, LXSnapshot.ChannelFaderView, LXSnapshot.ParameterView, LXSnapshot.RackPatternView
Enclosing class:
LXSnapshot
public abstract sealed class LXSnapshot.View extends Object implements LXSerializable permits LXSnapshot.ParameterView, LXSnapshot.ChannelFaderView, LXSnapshot.ActivePatternView, LXSnapshot.RackPatternView
A view is a component of a snapshot, it's a single piece of the snapshot that is "looking at" one piece of state.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

    LXSerializable.Utils

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final BooleanParameter
    enabled
    Whether this view is enabled for recall or not.
    final LXSnapshot.ViewScope
    scope
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
     
    protected void
    finishTransition()
    Subclasses may override, indicates the completion of a transition
    abstract LXCommand
    getCommand()
    Gets a command version of this view's operation, needed to make this action undoable.
    abstract String
    getDescription()
    Gets a description of the behavior of the parameter or field represented by the view
    abstract String
    getLabel()
    Gets a descriptive label for the parameter or field represented by the view
    LXSnapshot
    getSnapshot()
    Returns the snapshot that this view belongs to
    abstract LXComponent
    getViewComponent()
    Gets the component that owns the parameter/field referenced by the view
    abstract String
    getViewPath()
    Gets a unique path identifier for this view in the context of its snapshot
    protected void
    interpolate(double amount)
    Subclasses may override, indicates the progress of a transition
    protected abstract boolean
    isDependentOf(LXComponent component)
    Subclasses must implement, determines whether the given view is dependent upon the specified component, and whether this view should be removed if the component is disposed
    void
    load(LX lx, JsonObject obj)
    Restores this instance from a JSON object
    protected abstract void
    recall()
    Subclasses must implement, should reapply the state of the view immediately
    void
    save(LX lx, JsonObject obj)
    Serializes this instance into the JSON object
    protected void
    startTransition()
    Subclasses may override, indicates the beginning of a transition

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • getLabel

      public abstract String getLabel()
      Gets a descriptive label for the parameter or field represented by the view
      Returns:
      Descriptive label for the parameter or field represented by the view

    • getDescription

      public abstract String getDescription()
      Gets a description of the behavior of the parameter or field represented by the view
      Returns:
      Description of the behavior of the parameter or field represented by the view

    • getViewComponent

      public abstract LXComponent getViewComponent()
      Gets the component that owns the parameter/field referenced by the view
      Returns:
      Component that owns the parameter/field referenced by the view

    • getViewPath

      public abstract String getViewPath()
      Gets a unique path identifier for this view in the context of its snapshot
      Returns:
      Unique path identifier for this view in the context of its snapshot

    • getSnapshot

      public LXSnapshot getSnapshot()
      Returns the snapshot that this view belongs to
      Returns:
      Snapshot that this view belongs to

    • getCommand

      public abstract LXCommand getCommand()
      Gets a command version of this view's operation, needed to make this action undoable.
      Returns:
      Command implementation of this view

    • isDependentOf

      protected abstract boolean isDependentOf(LXComponent component)
      Subclasses must implement, determines whether the given view is dependent upon the specified component, and whether this view should be removed if the component is disposed
      Parameters:
      component - Component to test
      Returns:
      true if this view depends upon that component's existence, false otherwise

    • recall

      protected abstract void recall()
      Subclasses must implement, should reapply the state of the view immediately

    • startTransition

      protected void startTransition()
      Subclasses may override, indicates the beginning of a transition

    • interpolate

      protected void interpolate(double amount)
      Subclasses may override, indicates the progress of a transition
      Parameters:
      amount - Amount of interpolation to apply

    • finishTransition

      protected void finishTransition()
      Subclasses may override, indicates the completion of a transition

    • save

      public void save(LX lx, JsonObject obj)
      Description copied from interface: LXSerializable
      Serializes this instance into the JSON object
      Specified by:
      save in interface LXSerializable
      Parameters:
      lx - LX instance
      obj - Object to serialize into

    • load

      public void load(LX lx, JsonObject obj)
      Description copied from interface: LXSerializable
      Restores this instance from a JSON object
      Specified by:
      load in interface LXSerializable
      Parameters:
      lx - LX instance
      obj - Object to deserialize

    • dispose

      public void dispose()