heronarts.lx.mixer

Class LXChannel

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.mixer.LXBus

heronarts.lx.mixer.LXAbstractChannel

heronarts.lx.mixer.LXChannel

All Implemented Interfaces:

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

public class LXChannel
extends LXAbstractChannel

A channel is a single component of the engine that has a set of patterns from which it plays and rotates. It also has a fader to control how this channel is blended with the channels before it.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class heronarts.lx.mixer.LXAbstractChannel

LXAbstractChannel.CrossfadeGroup, LXAbstractChannel.MidiListener, LXAbstractChannel.Profiler

Nested classes/interfaces inherited from class heronarts.lx.mixer.LXBus

LXBus.ClipListener

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	autoCycleEnabled Whether auto pattern transition is enabled on this channel
EnumParameter<LXChannel.AutoCycleMode>	autoCycleMode Auto-cycle to a random pattern, not the next one
BoundedParameter	autoCycleTimeSecs Time in seconds after which transition thru the pattern set is automatically initiated.
BooleanParameter	controlsExpanded Whether the channel control UI is expanded
MutableParameter	controlSurfaceFocusIndex
MutableParameter	controlSurfaceFocusLength
DiscreteParameter	focusedPattern Which pattern is focused in the channel
protected static String	KEY_IS_GROUP
static int	NO_PATTERN_INDEX
static String	PATH_ACTIVE
static String	PATH_ACTIVE_PATTERN
static String	PATH_NEXT_PATTERN
static String	PATH_PATTERN
List<LXPattern>	patterns
ObjectParameter<LXBlend>	transitionBlendMode
BooleanParameter	transitionEnabled
BoundedParameter	transitionTimeSecs
BooleanParameter	triggerPatternCycle

Fields inherited from class heronarts.lx.mixer.LXAbstractChannel

blendBuffer, blendMode, colors, crossfadeGroup, cueActive, enabled, fader, index, midiChannel, midiMonitor

Fields inherited from class heronarts.lx.mixer.LXBus

arm, clips, effects, mutableEffects, PATH_EFFECT, selected

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

Constructor Summary

Constructors

Constructor and Description
LXChannel(LX lx, int index, LXPattern[] patterns)

Method Summary

Modifier and Type	Method and Description
void	addListener(LXChannel.Listener listener)
LXChannel	addPattern(LXPattern pattern)
LXChannel	addPattern(LXPattern pattern, int index)
protected LXClip	constructClip(int index)
LXBus	disableAutoCycle()
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
LXBus	enableAutoCycle(double autoCycleThreshold) Enable automatic transition from pattern to pattern on this channel
LXPattern	getActivePattern()
int	getActivePatternIndex() Returns the index of the currently active pattern, if any
double	getAutoCycleProgress() Return progress towards making a cycle
LXPattern	getFocusedPattern() Returns the pattern that currently has focus in this channel's pattern list.
int	getFocusedPatternIndex()
LXGroup	getGroup() Returns the group that this channel belongs to
LXPattern	getNextPattern()
int	getNextPatternIndex()
LXPattern	getPattern(int index)
LXPattern	getPattern(String label)
LXPattern	getPatternByClassName(String className)
List<LXPattern>	getPatterns()
LXPattern	getTargetPattern()
double	getTransitionProgress() Return progress through a transition
LXChannel	goNextPattern() Activates the next pattern in this channel's pattern list
LXChannel	goPattern(LXPattern pattern) Activates the given pattern, which must belong to this channel.
LXChannel	goPatternIndex(int i) Activates the pattern at the given index, if it is within the bounds of this channel's pattern list.
LXChannel	goPreviousPattern() Activates the previous pattern in this channel's pattern list
LXChannel	goRandomPattern() Activates a randomly seleted pattern on the channel, from the set of patterns that have auto cycle enabled.
boolean	handleOscMessage(OscMessage message, String[] parts, int index) Handles an OSC message sent to this component.
void	load(LX lx, JsonObject obj) Loads the LX component.
void	loop(double deltaMs)
void	midiDispatch(LXShortMessage message) Dispatch a MIDI message to all the active devices on this channel, without notifying listeners.
LXChannel	movePattern(LXPattern pattern, int index)
protected void	onModelChanged(LXModel model) Subclasses should override to handle changes to which model they are addressing.
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
LXChannel	reloadPattern(LXPattern pattern)
void	removeListener(LXChannel.Listener listener)
LXChannel	removePattern(LXPattern pattern)
void	save(LX lx, JsonObject obj) Serializes the LX component.
LXChannel	setPatterns(LXPattern[] patterns)

Methods inherited from class heronarts.lx.mixer.LXAbstractChannel

addListener, addMidiListener, constructProfiler, getIndex, getPath, midiMessage, removeListener, removeMidiListener

Methods inherited from class heronarts.lx.mixer.LXBus

addClip, addClip, addClipListener, addEffect, addEffect, addListener, disposeClips, getClip, getClip, getEffect, getEffect, getEffects, isChannel, isEmptyGroup, isGroup, isInGroup, loop, moveEffect, reloadEffect, removeClip, removeClip, removeClipListener, removeEffect, removeListener, setMixer, 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, 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

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

NO_PATTERN_INDEX

public static final int NO_PATTERN_INDEX

See Also:

Constant Field Values

focusedPattern

public final DiscreteParameter focusedPattern

Which pattern is focused in the channel

controlsExpanded

public final BooleanParameter controlsExpanded

Whether the channel control UI is expanded

autoCycleEnabled

public final BooleanParameter autoCycleEnabled

Whether auto pattern transition is enabled on this channel

autoCycleMode

public final EnumParameter<LXChannel.AutoCycleMode> autoCycleMode

Auto-cycle to a random pattern, not the next one

autoCycleTimeSecs

public final BoundedParameter autoCycleTimeSecs

Time in seconds after which transition thru the pattern set is automatically initiated.

transitionTimeSecs

public final BoundedParameter transitionTimeSecs

transitionEnabled

public final BooleanParameter transitionEnabled

transitionBlendMode

public final ObjectParameter<LXBlend> transitionBlendMode

patterns

public final List<LXPattern> patterns

controlSurfaceFocusIndex

public final MutableParameter controlSurfaceFocusIndex

controlSurfaceFocusLength

public final MutableParameter controlSurfaceFocusLength

triggerPatternCycle

public final BooleanParameter triggerPatternCycle

PATH_PATTERN

public static final String PATH_PATTERN

See Also:

Constant Field Values

PATH_ACTIVE

public static final String PATH_ACTIVE

See Also:

Constant Field Values

PATH_ACTIVE_PATTERN

public static final String PATH_ACTIVE_PATTERN

See Also:

Constant Field Values

PATH_NEXT_PATTERN

public static final String PATH_NEXT_PATTERN

See Also:

Constant Field Values

KEY_IS_GROUP

protected static final String KEY_IS_GROUP

See Also:

Constant Field Values

Constructor Detail

LXChannel

public LXChannel(LX lx,
                 int index,
                 LXPattern[] patterns)

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 LXAbstractChannel

Parameters:

p - Parameter that has a value change

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 LXBus

Parameters:

model - New model

addListener

public final void addListener(LXChannel.Listener listener)

removeListener

public final void removeListener(LXChannel.Listener 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 LXBus

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

midiDispatch

public void midiDispatch(LXShortMessage message)

Description copied from class: LXAbstractChannel

Dispatch a MIDI message to all the active devices on this channel, without notifying listeners.

Overrides:

midiDispatch in class LXAbstractChannel

Parameters:

message - Message

getGroup

public LXGroup getGroup()

Description copied from class: LXBus

Returns the group that this channel belongs to

Overrides:

getGroup in class LXBus

Returns:

Group that this channel belongs to, or null

constructClip

protected LXClip constructClip(int index)

Specified by:

constructClip in class LXBus

getPatterns

public final List<LXPattern> getPatterns()

getPattern

public final LXPattern getPattern(int index)

getPattern

public final LXPattern getPattern(String label)

getPatternByClassName

public final LXPattern getPatternByClassName(String className)

setPatterns

public final LXChannel setPatterns(LXPattern[] patterns)

addPattern

public final LXChannel addPattern(LXPattern pattern)

addPattern

public final LXChannel addPattern(LXPattern pattern,
                                  int index)

removePattern

public final LXChannel removePattern(LXPattern pattern)

movePattern

public LXChannel movePattern(LXPattern pattern,
                             int index)

reloadPattern

public LXChannel reloadPattern(LXPattern pattern)

getFocusedPatternIndex

public final int getFocusedPatternIndex()

getFocusedPattern

public final LXPattern getFocusedPattern()

Returns the pattern that currently has focus in this channel's pattern list.

Returns:

Pattern focused in the list

getActivePatternIndex

public final int getActivePatternIndex()

Returns the index of the currently active pattern, if any

Returns:

Index of the currently active pattern

getActivePattern

public final LXPattern getActivePattern()

getTargetPattern

public final LXPattern getTargetPattern()

getNextPatternIndex

public final int getNextPatternIndex()

getNextPattern

public final LXPattern getNextPattern()

goPreviousPattern

public final LXChannel goPreviousPattern()

Activates the previous pattern in this channel's pattern list

Returns:

this

goNextPattern

public final LXChannel goNextPattern()

Activates the next pattern in this channel's pattern list

Returns:

this

goPattern

public final LXChannel goPattern(LXPattern pattern)

Activates the given pattern, which must belong to this channel.

Parameters:

pattern - Pattern to acivate

Returns:

this

goRandomPattern

public final LXChannel goRandomPattern()

Activates a randomly seleted pattern on the channel, from the set of patterns that have auto cycle enabled.

Returns:

this

goPatternIndex

public final LXChannel goPatternIndex(int i)

Activates the pattern at the given index, if it is within the bounds of this channel's pattern list.

Parameters:

i - Pattern index

Returns:

this

disableAutoCycle

public LXBus disableAutoCycle()

enableAutoCycle

public LXBus enableAutoCycle(double autoCycleThreshold)

Enable automatic transition from pattern to pattern on this channel

Parameters:

autoCycleThreshold - time in seconds

Returns:

this

getAutoCycleProgress

public double getAutoCycleProgress()

Return progress towards making a cycle

Returns:

amount of progress towards the next cycle

getTransitionProgress

public double getTransitionProgress()

Return progress through a transition

Returns:

amount of progress thru current transition

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXAbstractChannel

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 LXAbstractChannel

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 LXBus

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 LXBus

Parameters:

lx - LX instance

obj - Object to deserialize