Package heronarts.lx.snapshot

Class LXGlobalSnapshot

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.snapshot.LXSnapshot

heronarts.lx.snapshot.LXGlobalSnapshot

All Implemented Interfaces:

LXComponent.Renamable, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXGlobalSnapshot
extends LXSnapshot
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/interfaces inherited from class heronarts.lx.snapshot.LXSnapshot

LXSnapshot.ActivePatternView, LXSnapshot.ChannelFaderView, LXSnapshot.ParameterView, LXSnapshot.View, LXSnapshot.ViewScope, LXSnapshot.ViewType

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

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BooleanParameter	autoCycleEligible
final BoundedParameter	cycleTimeSecs
final BooleanParameter	hasCustomCycleTime
final BooleanParameter	hasCustomTransitionTime
final TriggerParameter	recall

Fields inherited from class heronarts.lx.snapshot.LXSnapshot

transitionTimeSecs, views

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
LXGlobalSnapshot(LX lx)

Method Summary

Modifier and Type	Method	Description
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	initialize()

Methods inherited from class heronarts.lx.snapshot.LXSnapshot

addDeviceView, addEffectView, addLayeredView, addParameterView, addPatternView, addView, addView, dispose, getClipChannel, initializeClipBus, initializeGlobalBus, isClipSnapshot, isGlobalSnapshot, load, removeView, save, update

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, onParameterChanged, removeParameter, removeParameter, removeParameter, removeParameter, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, 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

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

recall

public final TriggerParameter recall

autoCycleEligible

public final BooleanParameter autoCycleEligible

cycleTimeSecs

public final BoundedParameter cycleTimeSecs

hasCustomCycleTime

public final BooleanParameter hasCustomCycleTime

hasCustomTransitionTime

public final BooleanParameter hasCustomTransitionTime

Constructor Details

LXGlobalSnapshot

public LXGlobalSnapshot(LX lx)

Method Details

getIndex

public int getIndex()

Public accessor for the index of this snapshot in the list

Returns:

This snapshot's position in the global list

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

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

initialize

public void initialize()

Specified by:

initialize in class LXSnapshot