Package heronarts.lx.clip

Class PatternClipLane

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.clip.LXClipLane<PatternClipEvent>

heronarts.lx.clip.PatternClipLane

All Implemented Interfaces:

LXPath, LXSerializable, LXPatternEngine.Listener, LXParameterListener

public class PatternClipLane
extends LXClipLane<PatternClipEvent>
implements LXPatternEngine.Listener

Nested Class Summary

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

LXComponent.Author, LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable, LXComponent.Tags

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final LXPatternEngine	engine
static final String	KEY_RACK

Fields inherited from class heronarts.lx.clip.LXClipLane

clip, events, KEY_LANE_TYPE, mutableEvents, onChange, overdubActive, uiExpanded, uiHeight, uiMaximized, VALUE_LANE_TYPE_MIDI_NOTE, VALUE_LANE_TYPE_PARAMETER, VALUE_LANE_TYPE_PATTERN

Fields inherited from class heronarts.lx.LXComponent

childArrays, 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

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
List<Integer>	findEventIndices(LXPattern pattern)	Return a list of the indices of events in this clip lane that reference the given pattern
String	getLabel()	Accessor for the user-facing label of this component.
String	getPath()	Accessor for the path of this object.
protected PatternClipEvent	loadEvent(LX lx, JsonObject eventObj)
void	patternRemoved(LXPatternEngine channel, LXPattern pattern)
void	save(LX lx, JsonObject obj)	Serializes the LX component.
void	update(LX lx, JsonObject obj, PatternRack rack)

Methods inherited from class heronarts.lx.clip.LXClipLane

_insertEvent, beginLoadEvents, cursorInsertIndex, cursorInsertIndex, CursorOp, cursorPlayIndex, cursorPlayIndex, endLoadEvents, eventIndex, eventIndex, eventIterator, eventIterator, eventIterator, eventIterator, getIndex, getPreviousEvent, getPreviousEvent, getPreviousEvent, getUIThreadEvents, insertEvent, load, moveEvent, recordEvent, removeEvent, removeEvents, removeRange, removeRange, reverseEvents, setEventNormalized, setEventsCursors, stitchInner, stitchInsertIfNeeded, stitchOuter, stitchRemoveIfRedundant, stitchSelectionMax, stitchSelectionMin

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addInternalParameters, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isSnapshotControl, 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.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Methods inherited from interface heronarts.lx.mixer.LXPatternEngine.Listener

patternAdded, patternDidChange, patternEnabled, patternMoved, patternWillChange

Field Details

engine

public final LXPatternEngine engine

KEY_RACK

public static final String KEY_RACK

See Also:

• Constant Field Values

Method Details

patternRemoved

public void patternRemoved(LXPatternEngine channel,
 LXPattern pattern)

Specified by:

patternRemoved in interface LXPatternEngine.Listener

findEventIndices

public List<Integer> findEventIndices(LXPattern pattern)

Return a list of the indices of events in this clip lane that reference the given pattern

Parameters:

pattern - Pattern

Returns:

List of indices that reference this pattern, or null if there are none

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

getLabel

public String getLabel()

Description copied from class: LXComponent

Accessor for the user-facing label of this component. Objects that implement the LXComponent.Renamable interface may allow the user to change this value.

Specified by:

getLabel in interface LXPath

Specified by:

getLabel in class LXClipLane<PatternClipEvent>

Returns:

Label for this component

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 LXClipLane<PatternClipEvent>

Parameters:

lx - LX instance

obj - Object to serialize into

loadEvent

protected PatternClipEvent loadEvent(LX lx,
 JsonObject eventObj)

Specified by:

loadEvent in class LXClipLane<PatternClipEvent>

update

public void update(LX lx,
 JsonObject obj,
 PatternRack rack)

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