Package heronarts.lx

Class LXLayer

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXLayer

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXModelLayer, PlanesPattern.Plane

public abstract class LXLayer
extends LXLayeredComponent

A layer is a components that has a run method and operates on some other buffer component. The layer does not actually own the color buffer. An effect is an example of a layer, or patterns may compose themselves from multiple layers.

Nested Class Summary

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

LXModulatorComponent.Profiler

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

LXComponent.Author, LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable, LXComponent.Tags

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

LXSerializable.Utils

Field Summary

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, profiler

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LXLayer(LX lx)
protected	LXLayer(LX lx, LXDeviceComponent buffer)

Method Summary

Modifier and Type	Method	Description
int	getIndex()
String	getLabel()	Accessor for the user-facing label of this component.
String	getPath()	Accessor for the path of this object.
protected final void	onLoop(double deltaMs)
void	remove()	Removes this layer from the parent component after all layer execution is finished.
abstract void	run(double deltaMs)	Run this layer.

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, applyEffects, blendColor, blendColor, clearColors, copyColors, copyColors, copyColors, copyColors, dispose, getBuffer, getColor, getColor, getColors, getLayers, lightestColor, loop, 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, addModulator, addModulator, constructProfiler, getModulator, getModulators, moveModulator, removeModulator, startModulator

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addInternalParameters, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isSnapshotControl, isValidOscParameter, load, loadParameters, loadPreset, onParameterChanged, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, 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

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Constructor Details

LXLayer

protected LXLayer(LX lx)

LXLayer

protected LXLayer(LX lx,
 LXDeviceComponent buffer)

Method Details

getIndex

public int getIndex()

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

getLabel

public String getLabel()

Description copied from class: LXComponent

Accessor for the user-facing label of this component. Objects that implement the LXComponent.Renamable interface may allow the user to change this value.

Specified by:

getLabel in interface LXPath

Overrides:

getLabel in class LXComponent

Returns:

Label for this component

onLoop

protected final void onLoop(double deltaMs)

Overrides:

onLoop in class LXLayeredComponent

remove

public void remove()

Removes this layer from the parent component after all layer execution is finished.

run

public abstract void run(double deltaMs)

Run this layer.

Parameters:

deltaMs - Milliseconds elapsed since last frame