heronarts.lx.snapshot

Class LXSnapshotEngine

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.snapshot.LXSnapshotEngine

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXSnapshotEngine
extends LXComponent
implements LXOscComponent, LXLoopTask

The snapshot engine stores snapshots in time of the state of project settings. This includes mixer settings, the parameter values of the active patterns and effects that are running at the given time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXSnapshotEngine.AutoCycleMode
static class	LXSnapshotEngine.ChannelMode
static interface	LXSnapshotEngine.Listener
static class	LXSnapshotEngine.MissingChannelMode

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
DiscreteParameter	autoCycleCursor
BooleanParameter	autoCycleEnabled Whether auto pattern transition is enabled on this channel
EnumParameter<LXSnapshotEngine.AutoCycleMode>	autoCycleMode Auto-cycle to a random snapshot, not the next one
BoundedParameter	autoCycleTimeSecs Time in seconds after which transition thru the pattern set is automatically initiated.
EnumParameter<LXSnapshotEngine.ChannelMode>	channelMode
EnumParameter<LXSnapshotEngine.MissingChannelMode>	missingChannelMode
static String	PATH_SNAPSHOT
BooleanParameter	recallEffect
BooleanParameter	recallMixer
BooleanParameter	recallModulation
BooleanParameter	recallPattern
List<LXSnapshot>	snapshots Public read-only view of all the snapshots.
BooleanParameter	transitionEnabled
BoundedParameter	transitionTimeSecs Amount of time taken in seconds to transition into a new snapshot view
BooleanParameter	triggerSnapshotCycle

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Constructor Summary

Constructors

Constructor and Description
LXSnapshotEngine(LX lx)

Method Summary

Modifier and Type	Method and Description
LXSnapshotEngine	addListener(LXSnapshotEngine.Listener listener)
LXSnapshot	addSnapshot() Adds a new snapshot that takes the current state of the program.
LXSnapshotEngine	addSnapshot(LXSnapshot snapshot) Adds a snapshot to the engine.
LXSnapshotEngine	addSnapshot(LXSnapshot snapshot, int index) Adds a snapshot to the engine.
void	clear() Clears all snapshots from the engine.
List<LXSnapshot.View>	findSnapshotViews(LXComponent component) Find all snapshot views that involve the selected component.
double	getAutoCycleProgress()
double	getTransitionProgress()
boolean	handleOscMessage(OscMessage message, String[] parts, int index) Handles an OSC message sent to this component.
void	load(LX lx, JsonObject obj) Loads the LX component.
void	loop(double deltaMs)
LXSnapshotEngine	moveSnapshot(LXSnapshot snapshot, int index) Moves a snapshot to a new order in the engine snapshot list
void	onParameterChanged(LXParameter parameter) Subclasses are free to override this if desired.
void	recall(LXSnapshot snapshot) Recall this snapshot, apply all of its values
void	recall(LXSnapshot snapshot, List<LXCommand> commands) Recall this snapshot, and populate an array of commands which would need to be undone by this operation.
LXSnapshotEngine	removeListener(LXSnapshotEngine.Listener listener)
LXSnapshotEngine	removeSnapshot(LXSnapshot snapshot) Removes a snapshot from the engine
void	removeSnapshotViews(LXComponent component) Remove all snapshot views that reference the given component
void	save(LX lx, JsonObject obj) Serializes the LX component.

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, dispose, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, loadParameters, removeParameter, removeParameter, saveParameters, setParent, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

snapshots

public final List<LXSnapshot> snapshots

Public read-only view of all the snapshots.

recallMixer

public final BooleanParameter recallMixer

recallPattern

public final BooleanParameter recallPattern

recallEffect

public final BooleanParameter recallEffect

recallModulation

public final BooleanParameter recallModulation

missingChannelMode

public final EnumParameter<LXSnapshotEngine.MissingChannelMode> missingChannelMode

channelMode

public final EnumParameter<LXSnapshotEngine.ChannelMode> channelMode

autoCycleEnabled

public final BooleanParameter autoCycleEnabled

Whether auto pattern transition is enabled on this channel

autoCycleMode

public final EnumParameter<LXSnapshotEngine.AutoCycleMode> autoCycleMode

Auto-cycle to a random snapshot, not the next one

autoCycleTimeSecs

public final BoundedParameter autoCycleTimeSecs

Time in seconds after which transition thru the pattern set is automatically initiated.

transitionTimeSecs

public final BoundedParameter transitionTimeSecs

Amount of time taken in seconds to transition into a new snapshot view

transitionEnabled

public final BooleanParameter transitionEnabled

triggerSnapshotCycle

public final BooleanParameter triggerSnapshotCycle

autoCycleCursor

public final DiscreteParameter autoCycleCursor

PATH_SNAPSHOT

public static final String PATH_SNAPSHOT

See Also:

Constant Field Values

Constructor Detail

LXSnapshotEngine

public LXSnapshotEngine(LX lx)

Method Detail

onParameterChanged

public void onParameterChanged(LXParameter parameter)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

parameter - Parameter that has a value change

addListener

public LXSnapshotEngine addListener(LXSnapshotEngine.Listener listener)

removeListener

public LXSnapshotEngine removeListener(LXSnapshotEngine.Listener listener)

addSnapshot

public LXSnapshot addSnapshot()

Adds a new snapshot that takes the current state of the program.

Returns:

New snapshot that holds a view of the current state

addSnapshot

public LXSnapshotEngine addSnapshot(LXSnapshot snapshot)

Adds a snapshot to the engine. This snapshot is assumed to already exist and have been somehow populated.

Parameters:

snapshot - Snapshot to add

Returns:

this

addSnapshot

public LXSnapshotEngine addSnapshot(LXSnapshot snapshot,
                                    int index)

Adds a snapshot to the engine. This snapshot is assumed to already exist and have been somehow populated.

Parameters:

snapshot - Snapshot to add

index - Index to add at

Returns:

this

removeSnapshot

public LXSnapshotEngine removeSnapshot(LXSnapshot snapshot)

Removes a snapshot from the engine

Parameters:

snapshot - Snapshot to remove

Returns:

this

moveSnapshot

public LXSnapshotEngine moveSnapshot(LXSnapshot snapshot,
                                     int index)

Moves a snapshot to a new order in the engine snapshot list

Parameters:

snapshot - Snapshot

index - New position to occupy

Returns:

this

recall

public void recall(LXSnapshot snapshot)

Recall this snapshot, apply all of its values

Parameters:

snapshot - The snapshot to recall

recall

public void recall(LXSnapshot snapshot,
                   List<LXCommand> commands)

Recall this snapshot, and populate an array of commands which would need to be undone by this operation.

Parameters:

snapshot - Snapshot to recall

commands - Array to populate with all the commands processed

getTransitionProgress

public double getTransitionProgress()

getAutoCycleProgress

public double getAutoCycleProgress()

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

clear

public void clear()

Clears all snapshots from the engine. Generally should not be publicly used.

handleOscMessage

public boolean handleOscMessage(OscMessage message,
                                String[] parts,
                                int index)

Description copied from class: LXComponent

Handles an OSC message sent to this component. By default this method handles registered components and parameters, but subclasses may override this method to handle different types of OSC messages.

Specified by:

handleOscMessage in interface LXOscComponent

Overrides:

handleOscMessage in class LXComponent

Parameters:

message - Full OSC message object

parts - The OSC address pattern, broken into an array of parts

index - Which index into the parts array corresponds to this component's children

Returns:

true if the OSC message was handled and should be considered consumed, false otherwise

findSnapshotViews

public List<LXSnapshot.View> findSnapshotViews(LXComponent component)

Find all snapshot views that involve the selected component. This is typically called before removal of that component to identify now-defunct references.

Parameters:

component - Component

Returns:

List of all views that reference this component, or null

removeSnapshotViews

public void removeSnapshotViews(LXComponent component)

Remove all snapshot views that reference the given component

Parameters:

component - Component that is referenced

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 LXComponent

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 LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize