heronarts.lx.snapshot

Class LXSnapshot.ParameterView

java.lang.Object

heronarts.lx.snapshot.LXSnapshot.View

heronarts.lx.snapshot.LXSnapshot.ParameterView

All Implemented Interfaces:

LXSerializable

Enclosing class:

LXSnapshot

public class LXSnapshot.ParameterView
extends LXSnapshot.View

Class for the recall of a simple parameter value

Nested Class Summary

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

LXSerializable.Utils

Field Summary

Fields inherited from class heronarts.lx.snapshot.LXSnapshot.View

enabled, scope

Method Summary

Modifier and Type	Method and Description
protected void	finishTransition() Subclasses may override, indicates the completion of a transition
LXCommand	getCommand() Gets a command version of this view's operation, needed to make this action undoable.
protected void	interpolate(double amount) Subclasses may override, indicates the progress of a transition
protected 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
protected 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 heronarts.lx.snapshot.LXSnapshot.View

dispose, getSnapshot, load

Methods inherited from class java.lang.Object

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

Method Detail

getCommand

public LXCommand getCommand()

Description copied from class: LXSnapshot.View

Gets a command version of this view's operation, needed to make this action undoable.

Specified by:

getCommand in class LXSnapshot.View

Returns:

Command implementation of this view

isDependentOf

protected boolean isDependentOf(LXComponent component)

Description copied from class: LXSnapshot.View

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

Specified by:

isDependentOf in class LXSnapshot.View

Parameters:

component - Component to test

Returns:

true if this view depends upon that component's existence, false otherwise

recall

protected void recall()

Description copied from class: LXSnapshot.View

Subclasses must implement, should reapply the state of the view immediately

Specified by:

recall in class LXSnapshot.View

startTransition

protected void startTransition()

Description copied from class: LXSnapshot.View

Subclasses may override, indicates the beginning of a transition

Overrides:

startTransition in class LXSnapshot.View

interpolate

protected void interpolate(double amount)

Description copied from class: LXSnapshot.View

Subclasses may override, indicates the progress of a transition

Overrides:

interpolate in class LXSnapshot.View

Parameters:

amount - Amount of interpolation to apply

finishTransition

protected void finishTransition()

Description copied from class: LXSnapshot.View

Subclasses may override, indicates the completion of a transition

Overrides:

finishTransition in class LXSnapshot.View

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

Overrides:

save in class LXSnapshot.View

Parameters:

lx - LX instance

obj - Object to serialize into