Uses of Class
heronarts.lx.LXComponent
Package
Description
Core LX engine and component functionality.
Modulator classes for real-time audio analysis.
Classes for color manipulation, blending, color values.
Layer components that mutate existing buffers with standardized enable/disable.
Integration with MIDI devices.
Components that control automated modulation of parameter values.
Utility abstraction for values that vary over time.
Output support for various networking protocols.
Abstraction for values that may be monitored and controlled via UI.
Core classes for procedural animation.
-
Uses of LXComponent in heronarts.glx.ui.component
Modifier and TypeMethodDescriptionUIComponentLabel.setComponent
(LXComponent component) UIComponentLabel.setRoot
(LXComponent root) UIParameterLabel.setRoot
(LXComponent root) -
Uses of LXComponent in heronarts.lx
Modifier and TypeClassDescriptionclass
A component which may have its own scoped user-level modulators.class
The engine is the core class that runs the internal animations.class
class
A layer is a components that has a run method and operates on some other buffer component.class
Base class for system components that run in the engine, which have common attributes, such as parameters, modulators, and layers.class
A component that keeps a reference to a particular model, which may potentially be different than the global model.class
LXModelLayer<T extends LXModel>
Deprecated.No longer recommended, does not play nicely with dynamic models and view selectionclass
class
class
Class to represent a musical tempo at which patterns are operating.Modifier and TypeFieldDescriptionfinal Map<String,
LXComponent> LXComponent.children
An immutable view of the map of child components.Modifier and TypeMethodDescription<T extends LXComponent>
TLX.instantiateComponent
(Class<? extends T> cls, Class<T> type) <T extends LXComponent>
TLX.instantiateComponent
(String className, Class<T> type) Modifier and TypeMethodDescriptionprotected 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.LXDeviceComponent.addControlSurface
(LXMidiSurface surface) protected final LXComponent
LXComponent.addInternalParameter
(String path, LXParameter parameter) Internal implementation parameters.protected LXComponent
LXComponent.addLegacyInternalParameter
(String legacyPath, LXParameter parameter) Adds a redundant internal legacy parameter path.protected LXComponent
LXComponent.addLegacyParameter
(String legacyPath, LXParameter parameter) Adds a redundant legacy parameter path.protected final 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 final LXComponent
LXComponent.addParameters
(LXParameter.Collection parameters) Add all parameters from a collection of parametersprotected LXComponent
LXComponent.copyParameters
(LXComponent that) Utility method to copy all parameter values from another component.Accesses the child component object at a given path.LX.getComponent
(int componentId) Gets a component by its raw component idstatic LXComponent
LXPath.getComponent
(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchystatic LXComponent
LXPath.getComponent
(LX lx, String path) Globally retrieves an LX component with a path in the hierarchyfinal LXComponent
LXComponent.getParent()
Accessor for the parent component.LXPath.getParent()
Returns the component that this object belongs toLX.getProjectComponent
(int projectId) Gets a component by its id from the project file (which may have been remapped)LXDeviceComponent.removeControlSurface
(LXMidiSurface surface) protected LXComponent
LXDeviceComponent.removeCustomRemoteControl
(LXParameter parameter) protected LXComponent
LXComponent.removeParameter
(LXParameter parameter) Removes a parameter from the component.protected LXComponent
LXComponent.removeParameter
(LXParameter parameter, boolean disposeModulations) protected LXComponent
LXComponent.removeParameter
(String path) Removes a parameter from the component.protected LXComponent
LXComponent.removeParameter
(String path, boolean removeModulations) Removes a parameter from the component.protected LXComponent
LXComponent.setDescription
(String description) protected final LXComponent
LXComponent.setParent
(LXComponent parent) Registers this component with a parent object in the hierarchy.Modifier and TypeMethodDescriptionprotected 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 hierarchydefault 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 rootstatic LXComponent
LXPath.getComponent
(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchystatic String
LXComponent.getComponentName
(LXComponent component, String suffix) Gets the name of an LXComponent object with suffix removedstatic LXParameter
LXPath.getParameter
(LXComponent root, String path) Globally retrieves an LX parameter at a certain scope in the LX hierarchyLX.getPresetFile
(LXComponent device, String name) LX.getPresetFolder
(LXComponent device) Get the folder to hold presets for a devicedefault boolean
LXPath.isDescendant
(LXComponent root) Determines whether this path object is a descendant of a root componentprotected static void
LXComponent.loadParameters
(LXComponent component, JsonObject obj, Map<String, LXParameter> parameters) Utility function to load a set of parametersLXEngine.registerComponent
(String path, LXComponent component) Register a component with the engine.protected final 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 JsonObjectstatic JsonObject
LXSerializable.Utils.toObject
(LXComponent component, boolean stripIds) Serializes an LXComponent to a JsonObjectLXComponent.toString
(LXComponent root) Returns a useful debug string for the component, indicating the class name along with the ID number and the canonical pathModifier and TypeMethodDescriptionprotected LXComponent
LXComponent.addArray
(String path, List<? extends LXComponent> childArray) Registers an array of subcomponents with this component.boolean
LX.canInstantiate
(Class<? extends LXComponent> clz) static String
LXComponent.getCategory
(Class<? extends LXComponent> clazz) 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 foundstatic 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
Modifier and TypeClassDescriptionclass
Implementation of Audio Definition Model data.class
class
A frequency gate monitors a Graphic Meter for a particular frequency range and triggers when that range passes a certain threshold.class
A DecibelMeter is a modulator that returns the level of an audio signal.class
class
protected class
class
class
A graphic meter splits the signal into frequency bands and computes envelopes for each of the bands independently.class
class
class
class
class
class
class
class
-
Uses of LXComponent in heronarts.lx.blend
Modifier and TypeClassDescriptionclass
class
class
class
class
The dissolve blend is a special blend used in the crossfader.class
class
class
class
An LXBlend is a loop-based implementation of a compositing algorithm.static class
class
class
class
class
class
-
Uses of LXComponent in heronarts.lx.clip
Modifier and TypeClassDescriptionclass
class
class
class
class
class
Modifier and TypeMethodDescriptionprotected void
LXClip.registerComponent
(LXComponent component) protected void
LXClip.unregisterComponent
(LXComponent component) -
Uses of LXComponent in heronarts.lx.clipboard
Modifier and TypeMethodDescriptionClass<? extends LXComponent>
LXClipboardComponent.getComponentClass()
-
Uses of LXComponent in heronarts.lx.color
Modifier and TypeClassDescriptionclass
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
A palette is an object that is used to keep track of top-level color values and set modes of color computation.class
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
Modifier and TypeClassDescriptionstatic 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.Modifier and TypeMethodDescriptionprotected void
LXCommand.RemoveComponent.removeModulationMappings
(LXModulationEngine modulation, LXComponent component) protected void
LXCommand.RemoveComponent.removeSnapshotViews
(LXSnapshotEngine snapshots, LXComponent component) ModifierConstructorDescriptionAddEffect
(LXComponent parent, Class<? extends LXEffect> effectClass) AddEffect
(LXComponent parent, Class<? extends LXEffect> effectClass, JsonObject effectObj) LoadPreset
(LXComponent device, File file) MoveEffect
(LXComponent parent, LXEffect effect, int toIndex) protected
RemoveComponent
(LXComponent component) RemoveEffect
(LXComponent parent, LXEffect effect) -
Uses of LXComponent in heronarts.lx.dmx
Modifier and TypeClassDescriptionclass
Abstract DMX Modulator specifying a universe, channel, and number of bytes.class
Extracts a color from three DMX channels starting at a given address.class
A modulator converting DMX input to normalized output, with three modes: 8-bit: single DMX channel scaled to normalized output 16-bit: two DMX channels for high resolution, scaled to normalized output Range: A range from [min] to [max] within a DMX channel.class
class
-
Uses of LXComponent in heronarts.lx.effect
Modifier and TypeClassDescriptionclass
class
class
class
class
Class to represent an effect that may be applied to the color array.static class
Placeholder pattern for when a class is missingclass
LXModelEffect<T extends LXModel>
Deprecated.No longer recommended, does not play nicely with dynamic models and view selectionclass
class
-
Uses of LXComponent in heronarts.lx.effect.audio
-
Uses of LXComponent in heronarts.lx.effect.color
-
Uses of LXComponent in heronarts.lx.effect.image
-
Uses of LXComponent in heronarts.lx.effect.midi
-
Uses of LXComponent in heronarts.lx.midi
Modifier and TypeMethodDescriptionLXMidiEngine.findMappings
(LXComponent component) LXMidiEngine.removeMappings
(LXComponent component) Called when a component is disposed. -
Uses of LXComponent in heronarts.lx.mixer
Modifier and TypeClassDescriptionclass
Abstract subclass for both groups and channelsclass
Abstract representation of a channel, which could be a normal channel with patterns or the master channel.class
A channel is a single component of the engine that has a set of patterns from which it plays and rotates.class
class
Represents the master channel.class
Encapsulation of all the LX channel blending and mixer -
Uses of LXComponent in heronarts.lx.modulation
Modifier and TypeClassDescriptionclass
class
class
class
Modifier and TypeMethodDescription<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.removeModulations
(LXComponent component) -
Uses of LXComponent in heronarts.lx.modulator
Modifier and TypeClassDescriptionclass
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
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
class
class
A click is a simple modulator that fires a value of 1 every time its period has passed.class
class
A modulator that tracks the value of a parameter but damps motion over time according to rules.class
Modulator that provides randomization within normalized value range.class
class
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
class
Modulator that provides randomized triggering on an intervalclass
This modulator is a simple linear ramp from one value to another over a specified number of milliseconds.class
A Modulator is an abstraction for a variable with a value that varies over time, such as an envelope or a low frequency oscillator.static class
Placeholder pattern for when a class is missingclass
An LXPeriodicModulator is a modulator that moves through a cycle in a given amount of time.class
Utility subclass for modulators which oscillate in a range of values between a minimum and a maximum.class
class
class
class
class
class
class
class
class
Modulator that provides random noise outputclass
class
A quadratic envelope moves from one value to another along a quadratic curve.class
Modulator that provides randomization within normalized value range.class
A sawtooth LFO oscillates from one extreme value to another.class
class
A classic sinusoidal oscillator.class
class
class
Simple square wave LFO.class
class
class
A triangular LFO is a simple linear modulator that oscillates between a low and hi value over a specified time period.class
A sawtooth LFO oscillates from one extreme value to another. -
Uses of LXComponent in heronarts.lx.osc
-
Uses of LXComponent in heronarts.lx.output
Modifier and TypeClassDescriptionclass
class
class
Distributed Display Protocol is a simple protocol developed by 3waylabs.class
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
class
A datagram implementing the Kinet protocol, used by Color Kinetics devices.class
class
class
This class represents the output stage from the LX engine to real devices.class
Simple concrete output class which does nothing but group its children.class
class
UDP implementation of http://openpixelcontrol.org/class
TCP/IP streaming socket implementation of http://openpixelcontrol.org/class
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
Modifier and TypeMethodDescriptionFixedParameter.getParent()
FunctionalParameter.getParent()
LXListenableParameter.getParent()
NormalizedParameter.getParent()
Modifier and TypeMethodDescriptionFixedParameter.setComponent
(LXComponent parent, String path) FunctionalParameter.setComponent
(LXComponent parent, String path) LXListenableParameter.setComponent
(LXComponent component, String path) LXParameter.setComponent
(LXComponent component, String path) Sets the component that owns this parameterNormalizedParameter.setComponent
(LXComponent component, String path) -
Uses of LXComponent in heronarts.lx.pattern
Modifier and TypeClassDescriptionclass
class
Deprecated.class
LXModelPattern<T extends LXModel>
Deprecated.No longer recommended, does not play nicely with dynamic models and view selectionclass
A pattern is the core object that the animation engine uses to generate colors for all the points.static class
Placeholder pattern for when a class is missing -
Uses of LXComponent in heronarts.lx.pattern.audio
-
Uses of LXComponent in heronarts.lx.pattern.color
Modifier and TypeClassDescriptionclass
class
class
-
Uses of LXComponent in heronarts.lx.pattern.form
Modifier and TypeClassDescriptionclass
class
class
class
class
-
Uses of LXComponent in heronarts.lx.pattern.image
Modifier and TypeClassDescriptionclass
static class
class
class
-
Uses of LXComponent in heronarts.lx.pattern.strip
-
Uses of LXComponent in heronarts.lx.pattern.test
Modifier and TypeClassDescriptionclass
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
-
Uses of LXComponent in heronarts.lx.scheduler
-
Uses of LXComponent in heronarts.lx.script
-
Uses of LXComponent in heronarts.lx.snapshot
Modifier and TypeClassDescriptionclass
class
A snapshot holds a memory of the state of the program at a point in time.class
A snapshot holds a memory of the state of the program at a point in time.class
The snapshot engine stores snapshots in time of the state of project settings.Modifier and TypeMethodDescriptionLXSnapshotEngine.findSnapshotViews
(LXComponent component) Find all snapshot views that involve the selected component.protected boolean
LXSnapshot.ActivePatternView.isDependentOf
(LXComponent component) protected boolean
LXSnapshot.ChannelFaderView.isDependentOf
(LXComponent component) protected boolean
LXSnapshot.ParameterView.isDependentOf
(LXComponent 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 disposedLXSnapshotEngine.registerGlobal
(LXComponent component) Registers a global component for storage in global snapshotsvoid
LXSnapshotEngine.removeSnapshotViews
(LXComponent component) Remove all snapshot views that reference the given component -
Uses of LXComponent in heronarts.lx.structure
Modifier and TypeClassDescriptionclass
class
class
class
Class that represents a basic fixture with a fixed number of points, no hierarchy, and that is addressed with a single output definitionclass
An LXFixture is a rich LXComponent representing a physical lighting fixture which may be addressed by output packets.class
Utility base class that adds a bunch of parameters to a fixture object for selection of the most common protocols.class
class
class
class
class
class
Modifier and TypeMethodDescriptionprotected LXComponent
LXFixture.addParameter
(String path, LXParameter parameter) -
Uses of LXComponent in heronarts.lx.structure.view
-
Uses of LXComponent in heronarts.lx.studio.ui
Modifier and TypeMethodDescriptionUIContentPicker.setTarget
(LXComponent target, boolean effectsOnly) void
UIContentPicker.show
(LXStudio.UI ui, UI2dComponent source, LXComponent target, Event event) void
UIContentPicker.show
(LXStudio.UI ui, UI2dComponent source, LXComponent target, Event event, boolean effectsOnly) -
Uses of LXComponent in heronarts.lx.studio.ui.device
Modifier and TypeMethodDescriptionprotected void
UIDevice.addContentPicker
(LXStudio.UI ui, LXComponent target) ModifierConstructorDescriptionprotected
UIDevice
(LXStudio.UI ui, LXComponent component, float contentWidth) UIEffectDevice
(LXStudio.UI ui, LXComponent parent, LXEffect effect) protected
UIPresetDevice
(LXStudio.UI ui, LXComponent component, float contentWidth) -
Uses of LXComponent in heronarts.lx.studio.ui.modulation
Modifier and TypeFieldDescriptionfinal LXComponent
UIAbstractGlobalModulator.component
protected final LXComponent
UIModulator.modulator
ModifierConstructorDescriptionUIAbstractGlobalModulator
(UI ui, LX lx, LXComponent component, boolean isGlobalModulator, float x, float y, float w, float h) UIComponentModulator
(UI ui, LX lx, LXComponent component, float x, float y, float w) protected
UIModulator
(UI ui, LXComponent modulator, float x, float y, float w, float h)