heronarts.lx.clip

Class LXClip

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.clip.LXClip

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXSerializable, LXBus.Listener, LXOscComponent, LXParameterListener

Direct Known Subclasses:

LXAbstractChannelClip, LXMasterClip

public abstract class LXClip
extends LXRunnableComponent
implements LXOscComponent, LXComponent.Renamable, LXBus.Listener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LXClip.Listener

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
LXBus	bus
static String	KEY_INDEX
List<LXClipLane>	lanes
MutableParameter	length
BooleanParameter	loop
protected List<LXClipLane>	mutableLanes
protected LXParameterListener	parameterRecorder

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

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

Modifier	Constructor and Description
	LXClip(LX lx, LXBus bus, int index)
protected	LXClip(LX lx, LXBus bus, int index, boolean registerListener)

Method Summary

Modifier and Type	Method and Description
LXClip	addListener(LXClip.Listener listener)
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
void	effectAdded(LXBus channel, LXEffect effect)
void	effectMoved(LXBus channel, LXEffect effect)
void	effectRemoved(LXBus channel, LXEffect effect)
double	getBasis()
double	getCursor()
int	getIndex()
double	getLength()
String	getPath() Accessor for the path of this object.
void	load(LX lx, JsonObject obj) Loads the LX component.
protected void	loadLane(LX lx, String laneType, JsonObject laneObj)
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
protected void	onStartRecording()
protected void	registerComponent(LXComponent component)
LXClip	removeListener(LXClip.Listener listener)
LXClip	removeParameterLane(ParameterClipLane lane)
protected void	run(double deltaMs)
void	save(LX lx, JsonObject obj) Serializes the LX component.
LXClip	setIndex(int index)
protected void	unregisterComponent(LXComponent component)

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, loop, onReset, onStart, onStop, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, 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

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

length

public final MutableParameter length

loop

public final BooleanParameter loop

mutableLanes

protected final List<LXClipLane> mutableLanes

lanes

public final List<LXClipLane> lanes

bus

public final LXBus bus

parameterRecorder

protected final LXParameterListener parameterRecorder

KEY_INDEX

public static final String KEY_INDEX

See Also:

Constant Field Values

Constructor Detail

LXClip

public LXClip(LX lx,
              LXBus bus,
              int index)

LXClip

protected LXClip(LX lx,
                 LXBus bus,
                 int index,
                 boolean registerListener)

Method Detail

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

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

getLength

public double getLength()

removeParameterLane

public LXClip removeParameterLane(ParameterClipLane lane)

addListener

public LXClip addListener(LXClip.Listener listener)

removeListener

public LXClip removeListener(LXClip.Listener listener)

getCursor

public double getCursor()

getBasis

public double getBasis()

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 LXRunnableComponent

Parameters:

p - Parameter that has a value change

onStartRecording

protected void onStartRecording()

registerComponent

protected void registerComponent(LXComponent component)

unregisterComponent

protected void unregisterComponent(LXComponent component)

getIndex

public int getIndex()

setIndex

public LXClip setIndex(int index)

run

protected void run(double deltaMs)

Specified by:

run in class LXRunnableComponent

effectAdded

public void effectAdded(LXBus channel,
                        LXEffect effect)

Specified by:

effectAdded in interface LXBus.Listener

effectRemoved

public void effectRemoved(LXBus channel,
                          LXEffect effect)

Specified by:

effectRemoved in interface LXBus.Listener

effectMoved

public void effectMoved(LXBus channel,
                        LXEffect effect)

Specified by:

effectMoved in interface LXBus.Listener

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

loadLane

protected void loadLane(LX lx,
                        String laneType,
                        JsonObject laneObj)

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