heronarts.lx.pattern

Class LXPattern

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXDeviceComponent

heronarts.lx.pattern.LXPattern

All Implemented Interfaces:

LXComponent.Renamable, LXLayeredComponent.Buffered, LXLoopTask, LXPath, LXSerializable, LXMidiListener, LXModulationContainer, LXOscComponent, LXParameterListener

Direct Known Subclasses:

GradientPattern, GraphicEqualizerPattern, LXModelPattern, LXPattern.Placeholder, NoisePattern, P3LXPattern, PlanesPattern, SolidPattern, SparklePattern, TestPattern

public abstract class LXPattern
extends LXDeviceComponent
implements LXComponent.Renamable, LXLayeredComponent.Buffered, LXOscComponent

A pattern is the core object that the animation engine uses to generate colors for all the points.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXPattern.Placeholder Placeholder pattern for when a class is missing
class	LXPattern.Profiler

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

LXLayeredComponent.Buffered

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

LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
BooleanParameter	autoCycleEligible
LXPattern.Profiler	profiler
protected double	runMs

Fields inherited from class heronarts.lx.LXDeviceComponent

controlsExpanded, crashed, DEVICE_CATEGORY_NAME_SORT, DEVICE_VERSION_UNSPECIFIED, KEY_DEVICE_VERSION, modulation, modulationExpanded

Fields inherited from class heronarts.lx.LXLayeredComponent

colors, layers, palette

Fields inherited from class heronarts.lx.LXModelComponent

model

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators

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
protected	LXPattern(LX lx)

Method Summary

Modifier and Type	Method and Description
LXPattern	clearInterval() Clears a timer interval set to this pattern.
LXChannel	getChannel() Gets the channel that this pattern is loaded in.
int	getIndex()
String	getPath() Accessor for the path of this object.
boolean	hasInterval() Tests whether there is an interval for this pattern.
boolean	isAutoCycleEligible() Determines whether this pattern is eligible to be run at the moment.
boolean	isInInterval() Tests whether this pattern is in an eligible interval.
void	onActive() Subclasses may override this method.
void	onInactive() Subclasses may override this method.
protected void	onLoop(double deltaMs)
void	onTransitionEnd() Subclasses may override this method.
void	onTransitionStart() Subclasses may override this method.
protected abstract void	run(double deltaMs) Main pattern loop function.
LXPattern	setAutoCycleEligible(boolean eligible) Sets whether this pattern is eligible for automatic selection.
LXPattern	setChannel(LXChannel channel) Called by the engine when pattern is loaded onto a channel.
void	setIndex(int index)
LXPattern	setInterval(int begin, int end) Set an interval during which this pattern is allowed to run.
LXPattern	toggleAutoCycleEligible() Toggles the eligibility state of this pattern.

Methods inherited from class heronarts.lx.LXDeviceComponent

getCategory, getCrash, getCrashStackTrace, getDeviceVersion, getModulationEngine, getRemoteControls, isRemoteControl, loop, save, setRemoteControls

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, blendColor, blendColor, clearColors, dispose, getBuffer, getColor, getColor, getColors, getLayers, removeLayer, setBuffer, setBuffer, setColor, setColor, setColor, setColors, subtractColor

Methods inherited from class heronarts.lx.LXModelComponent

getModel, onModelChanged, setModel

Methods inherited from class heronarts.lx.LXModulatorComponent

addModulator, addModulator, addModulator, constructProfiler, 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, handleOscMessage, load, 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, handleOscMessage

Methods inherited from interface heronarts.lx.midi.LXMidiListener

aftertouchReceived, controlChangeReceived, noteOffReceived, noteOnReceived, pitchBendReceived, programChangeReceived

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

autoCycleEligible

public final BooleanParameter autoCycleEligible

runMs

protected double runMs

profiler

public final LXPattern.Profiler profiler

Constructor Detail

LXPattern

protected LXPattern(LX lx)

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

setIndex

public void setIndex(int index)

getIndex

public int getIndex()

getChannel

public final LXChannel getChannel()

Gets the channel that this pattern is loaded in. May be null if the pattern is not yet loaded onto any channel.

Returns:

Channel pattern is loaded onto

setChannel

public final LXPattern setChannel(LXChannel channel)

Called by the engine when pattern is loaded onto a channel. This may only be called once, by the engine. Do not call directly.

Parameters:

channel - Channel pattern is loaded onto

Returns:

this

setInterval

public LXPattern setInterval(int begin,
                             int end)

Set an interval during which this pattern is allowed to run. Begin and end times are specified in minutes of the daytime. So midnight corresponds to the value of 0, 360 would be 6:00am, 1080 would be 18:00 (or 6:00pm)

Parameters:

begin - Interval start time

end - Interval end time

Returns:

this

clearInterval

public LXPattern clearInterval()

Clears a timer interval set to this pattern.

Returns:

this

hasInterval

public final boolean hasInterval()

Tests whether there is an interval for this pattern.

Returns:

true if there is an interval

isInInterval

public final boolean isInInterval()

Tests whether this pattern is in an eligible interval.

Returns:

true if the pattern has an interval, and is currently in it.

setAutoCycleEligible

public final LXPattern setAutoCycleEligible(boolean eligible)

Sets whether this pattern is eligible for automatic selection.

Parameters:

eligible - Whether eligible for auto-rotation

Returns:

this

toggleAutoCycleEligible

public final LXPattern toggleAutoCycleEligible()

Toggles the eligibility state of this pattern.

Returns:

this

isAutoCycleEligible

public final boolean isAutoCycleEligible()

Determines whether this pattern is eligible to be run at the moment. A pattern is eligible if its eligibility flag has not been set to false, and if it either has no interval, or is currently in its interval.

Returns:

True if pattern is eligible to run now

onLoop

protected final void onLoop(double deltaMs)

Overrides:

onLoop in class LXLayeredComponent

run

protected abstract void run(double deltaMs)

Main pattern loop function. Invoked in a render loop. Subclasses must implement this function.

Parameters:

deltaMs - Number of milliseconds elapsed since last invocation

onActive

public void onActive()

Subclasses may override this method. It will be invoked when the pattern is about to become active. Patterns may take care of any initialization needed or reset parameters if desired.

onInactive

public void onInactive()

Subclasses may override this method. It will be invoked when the pattern is no longer active. Resources may be freed if desired.

onTransitionStart

public void onTransitionStart()

Subclasses may override this method. It will be invoked if a transition into this pattern is taking place. This will be called after onActive. This is not invoked on an already-running pattern. It is only called on the new pattern.

onTransitionEnd

public void onTransitionEnd()

Subclasses may override this method. It will be invoked when the transition into this pattern is complete.