heronarts.lx.snapshot

Class LXSnapshot

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.snapshot.LXSnapshot

All Implemented Interfaces:

LXComponent.Renamable, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXSnapshot
extends LXComponent
implements LXComponent.Renamable, LXOscComponent

A snapshot holds a memory of the state of the program at a point in time. The snapshot contains a collection of "views" which are memories of a piece of state in the program at some time. Typically this is a parameter value, but some special cases exist, like the active pattern on a channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LXSnapshot.ActivePatternView View for which pattern is active on a channel
class	LXSnapshot.ChannelFaderView
class	LXSnapshot.ParameterView Class for the recall of a simple parameter value
class	LXSnapshot.View A view is a component of a snapshot, it's a single piece of the snapshot that is "looking at" one piece of state.
static class	LXSnapshot.ViewScope
static class	LXSnapshot.ViewType Type of snapshot view

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
BooleanParameter	autoCycleEligible
BooleanParameter	recall
List<LXSnapshot.View>	views Public immutable list of all the views this snapshot comtains.

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
LXSnapshot(LX lx)

Method Summary

Modifier and Type	Method and Description
LXSnapshot.View	addView(JsonObject viewObj) Adds a view to this snapshot from prior saved state
void	addView(LXSnapshot.View view) Add a view to this snapshot
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
int	getIndex() Public accessor for the index of this snapshot in the list
String	getOscAddress() Gets the OSC address for this object
String	getOscPath() Accessor for this component's OSC path relative to its parent.
String	getPath() Accessor for the path of this object.
void	load(LX lx, JsonObject obj) Loads the LX component.
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
void	removeView(LXSnapshot.View view) Remove a view from this snapshot
void	save(LX lx, JsonObject obj) Serializes the LX component.

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, 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

handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

views

public final List<LXSnapshot.View> views

Public immutable list of all the views this snapshot comtains.

recall

public final BooleanParameter recall

autoCycleEligible

public final BooleanParameter autoCycleEligible

Constructor Detail

LXSnapshot

public LXSnapshot(LX lx)

Method Detail

onParameterChanged

public void onParameterChanged(LXParameter p)

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:

p - Parameter that has a value change

getPath

public String getPath()

Description copied from class: LXComponent

Accessor for the path of this object. Returns the path this component was registered with. Some subclasses may override this if path structure is dynamic.

Specified by:

getPath in interface LXPath

Overrides:

getPath in class LXComponent

Returns:

path of this component relative to its parent

getIndex

public int getIndex()

Public accessor for the index of this snapshot in the list

Returns:

This snapshot's position in the global list

addView

public LXSnapshot.View addView(JsonObject viewObj)

Adds a view to this snapshot from prior saved state

Parameters:

viewObj - JSON serialized view

Returns:

The new view object

addView

public void addView(LXSnapshot.View view)

Add a view to this snapshot

Parameters:

view - View

removeView

public void removeView(LXSnapshot.View view)

Remove a view from this snapshot

Parameters:

view - View to remove

getOscPath

public String getOscPath()

Description copied from class: LXComponent

Accessor for this component's OSC path relative to its parent. This by default is no different from LXComponent.getPath(), but certain subclasses may modify this to support different types of OSC paths that aren't required to match the LX hierarchy.

Overrides:

getOscPath in class LXComponent

Returns:

Path that this object can be accessed via OSC

getOscAddress

public String getOscAddress()

Description copied from class: LXComponent

Gets the OSC address for this object

Specified by:

getOscAddress in interface LXOscComponent

Overrides:

getOscAddress in class LXComponent

Returns:

Full OSC address for this component

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 LXComponent

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