heronarts.lx.mixer

Class LXBus

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.mixer.LXBus

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

Direct Known Subclasses:

LXAbstractChannel, LXMasterBus

public abstract class LXBus
extends LXModelComponent
implements LXOscComponent

Abstract representation of a channel, which could be a normal channel with patterns or the master channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LXBus.ClipListener
static interface	LXBus.Listener Listener interface for objects which want to be notified when the internal channel state is modified.
class	LXBus.Profiler

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	arm Arms the channel for clip recording.
List<LXClip>	clips
List<LXEffect>	effects
protected List<LXEffect>	mutableEffects
static String	PATH_EFFECT
BooleanParameter	selected Whether channel is selected in the UI

Fields inherited from class heronarts.lx.LXModelComponent

model

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators, profiler

Fields inherited from class heronarts.lx.LXComponent

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

Method Summary

Modifier and Type	Method and Description
LXClip	addClip()
LXClip	addClip(int index)
LXBus	addClipListener(LXBus.ClipListener listener)
LXBus	addEffect(LXEffect effect)
LXBus	addEffect(LXEffect effect, int index)
void	addListener(LXBus.Listener listener)
protected abstract LXClip	constructClip(int index)
protected LXModulatorComponent.Profiler	constructProfiler()
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
protected void	disposeClips()
LXClip	getClip(int index)
LXClip	getClip(int index, boolean create)
LXEffect	getEffect(int i)
LXEffect	getEffect(String label)
List<LXEffect>	getEffects()
LXGroup	getGroup() Returns the group that this channel belongs to
abstract int	getIndex()
boolean	handleOscMessage(OscMessage message, String[] parts, int index) Handles an OSC message sent to this component.
boolean	isChannel() Returns true if this is a basic channel
boolean	isEmptyGroup() Returns true if this is an empty group with no channels
boolean	isGroup() Returns true if this is a group channel
boolean	isInGroup() Returns true if this channel belongs to a group
void	load(LX lx, JsonObject obj) Loads the LX component.
void	loop(double deltaMs)
protected void	loop(double deltaMs, boolean runComponents)
LXBus	moveEffect(LXEffect effect, int index)
protected void	onModelChanged(LXModel model) Subclasses should override to handle changes to which model they are addressing.
LXBus	reloadEffect(LXEffect effect)
void	removeClip(int index)
void	removeClip(LXClip clip)
LXBus	removeClipListener(LXBus.ClipListener listener)
LXBus	removeEffect(LXEffect effect)
void	removeListener(LXBus.Listener listener)
void	save(LX lx, JsonObject obj) Serializes the LX component.
protected void	setMixer(LXMixerEngine mixer)
LXBus	stopClips()

Methods inherited from class heronarts.lx.LXModelComponent

getModel, setModel

Methods inherited from class heronarts.lx.LXModulatorComponent

addModulator, addModulator, addModulator, getModulator, getModulators, moveModulator, removeModulator, startModulator

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, getPath, loadParameters, onParameterChanged, 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

arm

public final BooleanParameter arm

Arms the channel for clip recording.

selected

public final BooleanParameter selected

Whether channel is selected in the UI

mutableEffects

protected final List<LXEffect> mutableEffects

effects

public final List<LXEffect> effects

clips

public final List<LXClip> clips

PATH_EFFECT

public static final String PATH_EFFECT

See Also:

Constant Field Values

Method Detail

constructProfiler

protected LXModulatorComponent.Profiler constructProfiler()

Overrides:

constructProfiler in class LXModulatorComponent

getIndex

public abstract int getIndex()

setMixer

protected void setMixer(LXMixerEngine mixer)

onModelChanged

protected void onModelChanged(LXModel model)

Description copied from class: LXModelComponent

Subclasses should override to handle changes to which model they are addressing. This method will be invoked at the start of the next core loop invocation, after the buffer has been updated.

Overrides:

onModelChanged in class LXModelComponent

Parameters:

model - New model

addListener

public final void addListener(LXBus.Listener listener)

removeListener

public final void removeListener(LXBus.Listener listener)

addClipListener

public LXBus addClipListener(LXBus.ClipListener listener)

removeClipListener

public LXBus removeClipListener(LXBus.ClipListener listener)

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

getGroup

public LXGroup getGroup()

Returns the group that this channel belongs to

Returns:

Group that this channel belongs to, or null

isGroup

public boolean isGroup()

Returns true if this is a group channel

Returns:

True if this is a group channel

isEmptyGroup

public boolean isEmptyGroup()

Returns true if this is an empty group with no channels

Returns:

true if this is a group with no subchannels

isChannel

public boolean isChannel()

Returns true if this is a basic channel

Returns:

True if this is a basic channel

isInGroup

public boolean isInGroup()

Returns true if this channel belongs to a group

Returns:

True if this channel is part of a group

addEffect

public final LXBus addEffect(LXEffect effect)

addEffect

public final LXBus addEffect(LXEffect effect,
                             int index)

removeEffect

public final LXBus removeEffect(LXEffect effect)

reloadEffect

public LXBus reloadEffect(LXEffect effect)

moveEffect

public LXBus moveEffect(LXEffect effect,
                        int index)

getEffects

public final List<LXEffect> getEffects()

getEffect

public LXEffect getEffect(int i)

getEffect

public LXEffect getEffect(String label)

getClip

public LXClip getClip(int index)

getClip

public LXClip getClip(int index,
                      boolean create)

addClip

public LXClip addClip()

addClip

public LXClip addClip(int index)

stopClips

public LXBus stopClips()

constructClip

protected abstract LXClip constructClip(int index)

removeClip

public void removeClip(LXClip clip)

removeClip

public void removeClip(int index)

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXModelComponent

loop

protected void loop(double deltaMs,
                    boolean runComponents)

disposeClips

protected void disposeClips()

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 LXModulatorComponent

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