heronarts.lx

Class LXLayeredComponent

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXDeviceComponent, LXLayer

public abstract class LXLayeredComponent
extends LXModelComponent
implements LXLoopTask

Base class for system components that run in the engine, which have common attributes, such as parameters, modulators, and layers. For instance, patterns, transitions, and effects are all LXComponents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LXLayeredComponent.Buffered Marker interface for instances which own their own buffer.

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

LXModulatorComponent.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
protected int[]	colors
protected List<LXLayer>	layers
protected LXPalette	palette

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

Modifier	Constructor and Description
protected	LXLayeredComponent(LX lx)
protected	LXLayeredComponent(LX lx, LXBuffer buffer)
protected	LXLayeredComponent(LX lx, LXDeviceComponent component)
protected	LXLayeredComponent(LX lx, String label)
protected	LXLayeredComponent(LX lx, String label, LXBuffer buffer)

Method Summary

Modifier and Type	Method and Description
protected LXLayeredComponent	addColor(int i, int c) Adds to the color of point i, using blendColor with ADD
protected LXLayeredComponent	addColor(LXModel model, int c) Adds the color to the fixture
protected LXLayer	addLayer(LXLayer layer)
protected void	afterLayers(double deltaMs)
protected LXLayeredComponent	blendColor(int i, int c, LXColor.Blend blendMode) Blend the color at index i with its existing value
protected LXLayeredComponent	blendColor(LXModel model, int c, LXColor.Blend blendMode)
protected LXLayeredComponent	clearColors() Clears all colors
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
protected LXBuffer	getBuffer()
protected int	getColor(int i) Retrieves the color at index i.
protected int	getColor(LXPoint p) Retrieves the color at a given point.
int[]	getColors()
List<LXLayer>	getLayers()
void	loop(double deltaMs)
protected void	onLoop(double deltaMs)
protected LXLayer	removeLayer(LXLayer layer)
LXLayeredComponent	setBuffer(LXBuffer buffer)
protected LXLayeredComponent	setBuffer(LXDeviceComponent component)
protected LXLayeredComponent	setColor(int i, int c) Sets the color of point i
protected LXLayeredComponent	setColor(LXModel model, int c) Sets the color of all points in a fixture
protected LXLayeredComponent	setColor(LXPoint p, int c) Sets the color of a point.
protected LXLayeredComponent	setColors(int c) Sets all points to one color
protected LXLayeredComponent	subtractColor(int i, int c) Subtracts from the color of point i, using blendColor with SUBTRACT

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, getPath, handleOscMessage, load, loadParameters, onParameterChanged, removeParameter, removeParameter, save, 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.LXPath

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

Field Detail

colors

protected int[] colors

layers

protected final List<LXLayer> layers

palette

protected final LXPalette palette

Constructor Detail

LXLayeredComponent

protected LXLayeredComponent(LX lx)

LXLayeredComponent

protected LXLayeredComponent(LX lx,
                             String label)

LXLayeredComponent

protected LXLayeredComponent(LX lx,
                             LXDeviceComponent component)

LXLayeredComponent

protected LXLayeredComponent(LX lx,
                             LXBuffer buffer)

LXLayeredComponent

protected LXLayeredComponent(LX lx,
                             String label,
                             LXBuffer buffer)

Method Detail

getBuffer

protected LXBuffer getBuffer()

getColors

public int[] getColors()

setBuffer

protected LXLayeredComponent setBuffer(LXDeviceComponent component)

setBuffer

public LXLayeredComponent setBuffer(LXBuffer buffer)

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXModelComponent

onLoop

protected void onLoop(double deltaMs)

afterLayers

protected void afterLayers(double deltaMs)

addLayer

protected final LXLayer addLayer(LXLayer layer)

removeLayer

protected final LXLayer removeLayer(LXLayer layer)

getLayers

public final List<LXLayer> getLayers()

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

getColor

protected int getColor(int i)

Retrieves the color at index i. This is provided mainly as documentation, but you should not generally use this method. You're better of just indexing directly to this.colors[i] and saving function call overhead.

Parameters:

i - Color index

Returns:

Color at that buffer index

getColor

protected int getColor(LXPoint p)

Retrieves the color at a given point. This is provided mainly as documentation, you should not generally use this method. You're better off just indexing directly by calling this.colors[p.index] and saving the function call overhead for a single point.

Parameters:

p - Point

Returns:

Color at that point

setColor

protected final LXLayeredComponent setColor(int i,
                                            int c)

Sets the color of point i

Parameters:

i - Point index

c - color

Returns:

this

setColor

protected final LXLayeredComponent setColor(LXPoint p,
                                            int c)

Sets the color of a point. This is provided for clarity, but if you're working with large pixel counts you may just skip calling this method and set colors[p.index] to avoid per-pixel function call overhead.

Parameters:

p - Point

c - color

Returns:

this

blendColor

protected final LXLayeredComponent blendColor(int i,
                                              int c,
                                              LXColor.Blend blendMode)

Blend the color at index i with its existing value

Parameters:

i - Index

c - New color

blendMode - blending mode

Returns:

this

blendColor

protected final LXLayeredComponent blendColor(LXModel model,
                                              int c,
                                              LXColor.Blend blendMode)

addColor

protected final LXLayeredComponent addColor(int i,
                                            int c)

Adds to the color of point i, using blendColor with ADD

Parameters:

i - Point index

c - color

Returns:

this

addColor

protected final LXLayeredComponent addColor(LXModel model,
                                            int c)

Adds the color to the fixture

Parameters:

model - model

c - New color

Returns:

this

subtractColor

protected final LXLayeredComponent subtractColor(int i,
                                                 int c)

Subtracts from the color of point i, using blendColor with SUBTRACT

Parameters:

i - Point index

c - color

Returns:

this

setColors

protected final LXLayeredComponent setColors(int c)

Sets all points to one color

Parameters:

c - Color

Returns:

this

setColor

protected final LXLayeredComponent setColor(LXModel model,
                                            int c)

Sets the color of all points in a fixture

Parameters:

model - Model

c - color

Returns:

this

clearColors

protected final LXLayeredComponent clearColors()

Clears all colors

Returns:

this