Uses of Class
heronarts.lx.LXComponent

Packages that use LXComponent

Package	Description
heronarts.lx	Core LX engine and component functionality.
heronarts.lx.audio	Modulator classes for real-time audio analysis.
heronarts.lx.blend
heronarts.lx.clip
heronarts.lx.clipboard
heronarts.lx.color	Classes for color manipulation, blending, color values.
heronarts.lx.command
heronarts.lx.effect	Layer components that mutate existing buffers with standardized enable/disable.
heronarts.lx.effect.color
heronarts.lx.effect.midi
heronarts.lx.midi	Integration with MIDI devices.
heronarts.lx.mixer
heronarts.lx.modulation	Components that control automated modulation of parameter values.
heronarts.lx.modulator	Utility abstraction for values that vary over time.
heronarts.lx.osc
heronarts.lx.output	Output support for various networking protocols.
heronarts.lx.parameter	Abstraction for values that may be monitored and controlled via UI.
heronarts.lx.pattern	Core classes for procedural animation.
heronarts.lx.pattern.color
heronarts.lx.pattern.form
heronarts.lx.pattern.test
heronarts.lx.pattern.texture
heronarts.lx.scheduler
heronarts.lx.snapshot
heronarts.lx.structure
heronarts.lx.studio.ui.device
heronarts.lx.studio.ui.modulation
heronarts.p3lx	Framework for embedding LX in Processing 3.
heronarts.p3lx.pattern
heronarts.p3lx.ui.component	Collection of standard UI components.

Uses of LXComponent in heronarts.lx

Classes in heronarts.lx with type parameters of type LXComponent

Modifier and Type	Class and Description
class	LXComponentArray<T extends LXComponent>

Subclasses of LXComponent in heronarts.lx

Modifier and Type	Class and Description
class	LXDeviceComponent A component which may have its own scoped user-level modulators.
class	LXEngine The engine is the core class that runs the internal animations.
class	LXEngine.Output
class	LXLayer A layer is a components that has a run method and operates on some other buffer component.
class	LXLayeredComponent Base class for system components that run in the engine, which have common attributes, such as parameters, modulators, and layers.
class	LXModelComponent A component that keeps a reference to a particular model, which may potentially be different than the global model.
class	LXModelLayer<T extends LXModel> Templatized version of the LXLayerclass, which strongly types a particular model.
class	LXModulatorComponent
class	LXRunnableComponent
class	Tempo Class to represent a musical tempo at which patterns are operating.

Methods in heronarts.lx with type parameters of type LXComponent

Modifier and Type	Method and Description
<T extends LXComponent> T	LX.instantiateComponent(Class<? extends T> cls, Class<T> type)
<T extends LXComponent> T	LX.instantiateComponent(String className, Class<T> type)

Methods in heronarts.lx that return LXComponent

Modifier and Type	Method and Description
protected LXComponent	LXComponent.addArray(String path, List<? extends LXComponent> childArray) Registers an array of subcomponents with this component.
protected LXComponent	LXComponent.addChild(String path, LXComponent child) Registers a child component with this component.
protected LXComponent	LXComponent.addInternalParameter(String path, LXParameter parameter) Internal implementation parameters.
protected LXComponent	LXComponent.addParameter(LXParameter parameter) Deprecated.
protected LXComponent	LXComponent.addParameter(String path, LXParameter parameter) Adds a parameter to the component at a fixed path.
protected LXComponent	LXComponent.copyParameters(LXComponent that) Utility method to copy all parameter values from another component.
LXComponent	LXComponent.getChild(String path) Accesses the child component object at a given path.
LXComponent	LX.getComponent(int componentId) Gets a component by its raw component id
static LXComponent	LXPath.getComponent(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchy
static LXComponent	LXPath.getComponent(LX lx, String path) Globally retrieves an LX component with a path in the hierarchy
LXComponent	LXPath.getParent() Returns the component that this object belongs to
LXComponent	LXComponent.getParent() Accessor for the parent component.
LXComponent	LX.getProjectComponent(int projectId) Gets a component by its id from the project file (which may have been remapped)
protected LXComponent	LXComponent.removeParameter(LXParameter parameter) Removes a parameter from the component.
protected LXComponent	LXComponent.removeParameter(String path) Removes a parameter from the component.
protected LXComponent	LXComponent.setParent(LXComponent parent) Registers this component with a parent object in the hierarchy.

Methods in heronarts.lx with parameters of type LXComponent

Modifier and Type	Method and Description
protected LXComponent	LXComponent.addChild(String path, LXComponent child) Registers a child component with this component.
protected LXComponent	LXComponent.copyParameters(LXComponent that) Utility method to copy all parameter values from another component.
static LXPath	LXPath.get(LXComponent root, String path) Globally retrieves an LX parameter at a certain scope in the LX hierarchy
default String	LXPath.getCanonicalLabel(LXComponent root) Returns the canonical user-facing label of this component.
default String	LXPath.getCanonicalPath(LXComponent root) Gets the canonical path of a Path object up to a given root
static LXComponent	LXPath.getComponent(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchy
static String	LXComponent.getComponentName(LXComponent component, String suffix) Gets the name of an LXComponent object with suffix removed
static LXParameter	LXPath.getParameter(LXComponent root, String path) Globally retrieves an LX parameter at a certain scope in the LX hierarchy
protected static void	LXComponent.loadParameters(LXComponent component, JsonObject obj, Map<String,LXParameter> parameters) Utility function to load a set of parameters
LXEngine	LXEngine.registerComponent(String path, LXComponent component) Register a component with the engine.
protected static void	LXComponent.saveParameters(LXComponent component, JsonObject obj, Map<String,LXParameter> parameters) Utility function to serialize a set of parameters
protected LXComponent	LXComponent.setParent(LXComponent parent) Registers this component with a parent object in the hierarchy.
static JsonObject	LXSerializable.Utils.toObject(LXComponent component) Serializes an LXComponent to a JsonObject
String	LXComponent.toString(LXComponent root) Returns a useful debug string for the component, indicating the class name along with the ID number and the canonical path

Method parameters in heronarts.lx with type arguments of type LXComponent

Modifier and Type	Method and Description
protected LXComponent	LXComponent.addArray(String path, List<? extends LXComponent> childArray) Registers an array of subcomponents with this component.
static String	LXComponent.getComponentName(Class<? extends LXComponent> cls) Gets the name of a component class, automatically removing the suffix of a generic LX superclass, if one is found
static String	LXComponent.getComponentName(Class<? extends LXComponent> component, String suffix) Gets the name of a component class, with a suffix removed

Uses of LXComponent in heronarts.lx.audio

Subclasses of LXComponent in heronarts.lx.audio

Modifier and Type	Class and Description
class	BandGate A frequency gate monitors a Graphic Meter for a particular frequency range and triggers when that range passes a certain threshold.
class	DecibelMeter A DecibelMeter is a modulator that returns the level of an audio signal.
class	GraphicMeter A graphic meter splits the signal into frequency bands and computes envelopes for each of the bands independently.
class	LXAudioComponent
class	LXAudioEngine
class	LXAudioInput
class	LXAudioOutput

Uses of LXComponent in heronarts.lx.blend

Subclasses of LXComponent in heronarts.lx.blend

Modifier and Type	Class and Description
class	AddBlend
class	DarkestBlend
class	DifferenceBlend
class	DissolveBlend The dissolve blend is a special blend used in the crossfader.
class	LightestBlend
class	LXBlend An LXBlend is a loop-based implementation of a compositing algorithm.
static class	LXBlend.FunctionalBlend
class	MultiplyBlend
class	NormalBlend
class	ScreenBlend
class	SubtractBlend

Uses of LXComponent in heronarts.lx.clip

Subclasses of LXComponent in heronarts.lx.clip

Modifier and Type	Class and Description
class	LXAbstractChannelClip
class	LXChannelClip
class	LXClip
class	LXClipEngine
class	LXGroupClip
class	LXMasterClip

Fields in heronarts.lx.clip declared as LXComponent

Modifier and Type	Field and Description
protected LXComponent	LXClipEvent.component

Methods in heronarts.lx.clip with parameters of type LXComponent

Modifier and Type	Method and Description
protected void	LXClip.registerComponent(LXComponent component)
protected void	LXClip.unregisterComponent(LXComponent component)

Uses of LXComponent in heronarts.lx.clipboard

Classes in heronarts.lx.clipboard with type parameters of type LXComponent

Modifier and Type	Class and Description
class	LXClipboardComponent<T extends LXComponent>

Methods in heronarts.lx.clipboard that return types with arguments of type LXComponent

Modifier and Type	Method and Description
Class<? extends LXComponent>	LXClipboardComponent.getComponentClass()

Uses of LXComponent in heronarts.lx.color

Subclasses of LXComponent in heronarts.lx.color

Modifier and Type	Class and Description
class	LXDynamicColor A dynamic color is a color that has a few different settings that allows it to either be fixed or to change its value over time.
class	LXPalette A palette is an object that is used to keep track of top-level color values and set modes of color computation.
class	LXSwatch A swatch is a set of up to 5 dynamic colors that can be referenced by patterns and effects.

Uses of LXComponent in heronarts.lx.command

Classes in heronarts.lx.command with type parameters of type LXComponent

Modifier and Type	Class and Description
static class	LXCommand.ComponentReference<T extends LXComponent> This reference class is used because the LXCommand engine might have actions in it that refer to components which have been deleted by subsequent operations.

Methods in heronarts.lx.command with parameters of type LXComponent

Modifier and Type	Method and Description
protected void	LXCommand.RemoveComponent.removeModulationMappings(LXModulationEngine modulation, LXComponent component)
protected void	LXCommand.RemoveComponent.removeSnapshotViews(LXSnapshotEngine snapshots, LXComponent component)

Constructors in heronarts.lx.command with parameters of type LXComponent

Constructor and Description
RemoveComponent(LXComponent component)

Uses of LXComponent in heronarts.lx.effect

Subclasses of LXComponent in heronarts.lx.effect

Modifier and Type	Class and Description
class	BlurEffect
class	DynamicsEffect
class	HueSaturationEffect
class	InvertEffect
class	LXEffect Class to represent an effect that may be applied to the color array.
static class	LXEffect.Placeholder Placeholder pattern for when a class is missing
class	LXModelEffect<T extends LXModel>
class	SparkleEffect
class	StrobeEffect

Uses of LXComponent in heronarts.lx.effect.color

Subclasses of LXComponent in heronarts.lx.effect.color

Modifier and Type	Class and Description
class	ColorizeEffect

Uses of LXComponent in heronarts.lx.effect.midi

Subclasses of LXComponent in heronarts.lx.effect.midi

Modifier and Type	Class and Description
class	GateEffect

Uses of LXComponent in heronarts.lx.midi

Subclasses of LXComponent in heronarts.lx.midi

Modifier and Type	Class and Description
class	LXMidiEngine

Methods in heronarts.lx.midi with parameters of type LXComponent

Modifier and Type	Method and Description
List<LXMidiMapping>	LXMidiEngine.findMappings(LXComponent component)
LXMidiEngine	LXMidiEngine.removeMappings(LXComponent component) Called when a component is disposed.

Uses of LXComponent in heronarts.lx.mixer

Subclasses of LXComponent in heronarts.lx.mixer

Modifier and Type	Class and Description
class	LXAbstractChannel Abstract subclass for both groups and channels
class	LXBus Abstract representation of a channel, which could be a normal channel with patterns or the master channel.
class	LXChannel A channel is a single component of the engine that has a set of patterns from which it plays and rotates.
class	LXGroup
class	LXMasterBus Represents the master channel.
class	LXMixerEngine Encapsulation of all the LX channel blending and mixer

Uses of LXComponent in heronarts.lx.modulation

Subclasses of LXComponent in heronarts.lx.modulation

Modifier and Type	Class and Description
class	LXCompoundModulation
class	LXModulationEngine
class	LXParameterModulation
class	LXTriggerModulation

Methods in heronarts.lx.modulation with parameters of type LXComponent

Modifier and Type	Method and Description
<T extends LXParameterModulation> List<T>	LXModulationEngine.findModulations(LXComponent component, List<T> modulations) Compiles all modulations that act upon any parameter or subcomponent of the given component, whether as source or target.
LXModulationEngine	LXModulationEngine.removeModulations(LXComponent component)

Uses of LXComponent in heronarts.lx.modulator

Subclasses of LXComponent in heronarts.lx.modulator

Modifier and Type	Class and Description
class	Accelerator An accelerator is a free-running modulator that changes its value based on velocity and acceleration, measured in units/second and units/second^2, respectively.
class	Accumulator An accumulator oscillates between increasing and decreasing value by some velocity such that it never overflows or stops moving outside of the floating point range.
class	ADEnvelope
class	ADSREnvelope
class	Click A click is a simple modulator that fires a value of 1 every time its period has passed.
class	DampedParameter A modulator that tracks the value of a parameter but damps motion over time according to rules.
class	FunctionalModulator An extendable modulator class that lets a custom normalized function be supplied by simply extending this class and supplying a compute() and invert() method.
class	HistoryBuffer
class	LinearEnvelope This modulator is a simple linear ramp from one value to another over a specified number of milliseconds.
class	LXModulator A Modulator is an abstraction for a variable with a value that varies over time, such as an envelope or a low frequency oscillator.
class	LXPeriodicModulator An LXPeriodicModulator is a modulator that moves through a cycle in a given amount of time.
class	LXRangeModulator Utility subclass for modulators which oscillate in a range of values between a minimum and a maximum.
class	MacroKnobs
class	MultiStageEnvelope
class	QuadraticEnvelope A quadratic envelope moves from one value to another along a quadratic curve.
class	SawLFO A sawtooth LFO oscillates from one extreme value to another.
class	SinLFO A classic sinusoidal oscillator.
class	SquareLFO Simple square wave LFO.
class	TriangleLFO A triangular LFO is a simple linear modulator that oscillates between a low and hi value over a specified time period.
class	VariableLFO A sawtooth LFO oscillates from one extreme value to another.

Methods in heronarts.lx.modulator with parameters of type LXComponent

Modifier and Type	Method and Description
LXParameter	LXModulator.setComponent(LXComponent component, String path)

Uses of LXComponent in heronarts.lx.osc

Subclasses of LXComponent in heronarts.lx.osc

Modifier and Type	Class and Description
class	LXOscEngine

Uses of LXComponent in heronarts.lx.output

Subclasses of LXComponent in heronarts.lx.output

Modifier and Type	Class and Description
class	ArtNetDatagram
class	ArtSyncDatagram
class	DDPDatagram Distributed Display Protocol is a simple protocol developed by 3waylabs.
class	DDPOutputGroup DDPOutput is a helper class that constructs and sends a set of DDPDatagram packets based upon a specified chunk size, which will typically be a function of either the LED layout or UDP network settings.
class	FadecandySocket
class	KinetDatagram A datagram implementing the Kinet protocol, used by Color Kinetics devices.
class	LXBufferOutput
class	LXDatagram
class	LXOutput This class represents the output stage from the LX engine to real devices.
class	LXOutputGroup Simple concrete output class which does nothing but group its children.
class	LXSocket
class	OPCDatagram UDP implementation of http://openpixelcontrol.org/
class	OPCSocket TCP/IP streaming socket implementation of http://openpixelcontrol.org/
class	StreamingACNDatagram Streaming ACN, also referred to as E1.31, is a standardized protocol for streaming DMX data over ACN protocol.

Uses of LXComponent in heronarts.lx.parameter

Methods in heronarts.lx.parameter that return LXComponent

Modifier and Type	Method and Description
LXComponent	NormalizedParameter.getParent()
LXComponent	LXListenableParameter.getParent()
LXComponent	FunctionalParameter.getParent()
LXComponent	FixedParameter.getParent()

Methods in heronarts.lx.parameter with parameters of type LXComponent

Modifier and Type	Method and Description
NormalizedParameter	NormalizedParameter.setComponent(LXComponent component, String path)
LXParameter	LXParameter.setComponent(LXComponent component, String path) Sets the component that owns this parameter
LXParameter	LXListenableParameter.setComponent(LXComponent component, String path)
LXParameter	FunctionalParameter.setComponent(LXComponent parent, String path)
LXParameter	FixedParameter.setComponent(LXComponent parent, String path)

Uses of LXComponent in heronarts.lx.pattern

Subclasses of LXComponent in heronarts.lx.pattern

Modifier and Type	Class and Description
class	GraphicEqualizerPattern
class	LifePattern
class	LXModelPattern<T extends LXModel> Templatized version of the LXPattern class, which strongly types a particular model.
class	LXPattern A pattern is the core object that the animation engine uses to generate colors for all the points.
static class	LXPattern.Placeholder Placeholder pattern for when a class is missing

Uses of LXComponent in heronarts.lx.pattern.color

Subclasses of LXComponent in heronarts.lx.pattern.color

Modifier and Type	Class and Description
class	GradientPattern
class	SolidPattern

Uses of LXComponent in heronarts.lx.pattern.form

Subclasses of LXComponent in heronarts.lx.pattern.form

Modifier and Type	Class and Description
class	PlanesPattern
class	PlanesPattern.Plane

Uses of LXComponent in heronarts.lx.pattern.test

Subclasses of LXComponent in heronarts.lx.pattern.test

Modifier and Type	Class and Description
class	TestPattern Braindead simple test pattern that iterates through all the nodes turning them on one by one in fixed order.

Uses of LXComponent in heronarts.lx.pattern.texture

Subclasses of LXComponent in heronarts.lx.pattern.texture

Modifier and Type	Class and Description
class	NoisePattern
class	SparklePattern

Uses of LXComponent in heronarts.lx.scheduler

Subclasses of LXComponent in heronarts.lx.scheduler

Modifier and Type	Class and Description
class	LXScheduledProject
class	LXScheduler

Uses of LXComponent in heronarts.lx.snapshot

Subclasses of LXComponent in heronarts.lx.snapshot

Modifier and Type	Class and Description
class	LXSnapshot A snapshot holds a memory of the state of the program at a point in time.
class	LXSnapshotEngine The snapshot engine stores snapshots in time of the state of project settings.

Methods in heronarts.lx.snapshot with parameters of type LXComponent

Modifier and Type	Method and Description
List<LXSnapshot.View>	LXSnapshotEngine.findSnapshotViews(LXComponent component) Find all snapshot views that involve the selected component.
protected abstract boolean	LXSnapshot.View.isDependentOf(LXComponent component) Subclasses must implement, determines whether the given view is dependent upon the specified component, and whether this view should be removed if the component is disposed
protected boolean	LXSnapshot.ParameterView.isDependentOf(LXComponent component)
protected boolean	LXSnapshot.ChannelFaderView.isDependentOf(LXComponent component)
protected boolean	LXSnapshot.ActivePatternView.isDependentOf(LXComponent component)
void	LXSnapshotEngine.removeSnapshotViews(LXComponent component) Remove all snapshot views that reference the given component

Uses of LXComponent in heronarts.lx.structure

Subclasses of LXComponent in heronarts.lx.structure

Modifier and Type	Class and Description
class	ArcFixture
class	GridFixture
class	JsonFixture
class	LXBasicFixture Class that represents a basic fixture with a fixed number of points, no hierarchy, and that is addressed with a single datagram packet.
class	LXFixture An LXFixture is a rich LXComponent representing a physical lighting fixture which may be addressed by output packets.
class	LXProtocolFixture Utility base class that adds a bunch of parameters to a fixture object for selection of the most common protocols.
class	LXStructure
class	LXStructure.Output
class	PointFixture
class	StripFixture

Methods in heronarts.lx.structure that return LXComponent

Modifier and Type	Method and Description
protected LXComponent	LXFixture.addParameter(String path, LXParameter parameter)

Uses of LXComponent in heronarts.lx.studio.ui.device

Fields in heronarts.lx.studio.ui.device declared as LXComponent

Modifier and Type	Field and Description
protected LXComponent	UIDevice.component

Constructors in heronarts.lx.studio.ui.device with parameters of type LXComponent

Constructor and Description
UIDevice(LXStudio.UI ui, LXComponent component, float contentWidth)

Uses of LXComponent in heronarts.lx.studio.ui.modulation

Fields in heronarts.lx.studio.ui.modulation declared as LXComponent

Modifier and Type	Field and Description
LXComponent	UIAbstractGlobalModulator.component
protected LXComponent	UIModulator.modulator

Constructors in heronarts.lx.studio.ui.modulation with parameters of type LXComponent

Constructor and Description
UIAbstractGlobalModulator(UI ui, LX lx, LXComponent component, boolean isModulator, float x, float y, float w, float h)
UIComponentModulator(UI ui, LX lx, LXComponent component, float x, float y, float w)
UIModulator(UI ui, LXComponent modulator, float x, float y, float w, float h)

Uses of LXComponent in heronarts.p3lx

Methods in heronarts.p3lx with type parameters of type LXComponent

Modifier and Type	Method and Description
<T extends LXComponent> T	P3LX.instantiateComponent(Class<? extends T> cls, Class<T> type)

Uses of LXComponent in heronarts.p3lx.pattern

Subclasses of LXComponent in heronarts.p3lx.pattern

Modifier and Type	Class and Description
class	P3LXPattern

Uses of LXComponent in heronarts.p3lx.ui.component

Methods in heronarts.p3lx.ui.component with parameters of type LXComponent

Modifier and Type	Method and Description
UIComponentLabel	UIComponentLabel.setComponent(LXComponent component)