Uses of Class
heronarts.lx.LXComponent
Packages that use 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
Methods in heronarts.glx.ui.component that return LXComponentMethods in heronarts.glx.ui.component with parameters of type LXComponentModifier and TypeMethodDescriptionUIComponentLabel.setComponent(LXComponent component) UIComponentLabel.setRoot(LXComponent root) UIParameterLabel.setRoot(LXComponent root) -
Uses of LXComponent in heronarts.lx
Subclasses of LXComponent in heronarts.lxModifier and TypeClassDescriptionclassA component which may have its own scoped user-level modulators.classThe engine is the core class that runs the internal animations.classclassA layer is a components that has a run method and operates on some other buffer component.classBase class for system components that run in the engine, which have common attributes, such as parameters, modulators, and layers.classA component that keeps a reference to a particular model, which may potentially be different than the global model.classLXModelLayer<T extends LXModel>Deprecated.No longer recommended, does not play nicely with dynamic models and view selectionclassclassclassClass to represent a musical tempo at which patterns are operating.Fields in heronarts.lx with type parameters of type LXComponentModifier and TypeFieldDescriptionfinal Map<String, LXComponent> LXDeviceComponent.automationChildrenAn immutable view of the map of child components.final Map<String, List<? extends LXComponent>> LXComponent.childArraysAn immutable view of the map of child array componentsfinal Map<String, LXComponent> LXComponent.childrenAn immutable view of the map of child components.Methods in heronarts.lx with type parameters of type LXComponentModifier and TypeMethodDescription<T extends LXComponent>
TLX.instantiateComponent(Class<? extends T> cls, Class<T> type) <T extends LXComponent>
TLX.instantiateComponent(String className, Class<T> type) Methods in heronarts.lx that return LXComponentModifier and TypeMethodDescriptionprotected LXComponentLXComponent.addArray(String path, List<? extends LXComponent> childArray) Registers an array of subcomponents with this component.protected LXComponentLXComponent.addChild(String path, LXComponent child) Registers a child component with this component.LXDeviceComponent.addControlSurface(LXMidiSurface surface) protected final LXComponentLXComponent.addInternalParameter(String path, LXParameter parameter) Internal implementation parameters.protected LXComponentLXComponent.addLegacyInternalParameter(String legacyPath, LXParameter parameter) Adds a redundant internal legacy parameter path.protected LXComponentLXComponent.addLegacyParameter(String legacyPath, LXParameter parameter) Adds a redundant legacy parameter path.protected final LXComponentLXComponent.addParameter(LXParameter parameter) Deprecated.protected LXComponentLXComponent.addParameter(String path, LXParameter parameter) Adds a parameter to the component at a fixed path.protected final LXComponentLXComponent.addParameters(LXParameter.Collection parameters) Add all parameters from a collection of parametersprotected LXComponentLXComponent.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 LXComponentLXPath.getComponent(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchystatic LXComponentLXPath.getComponent(LX lx, String path) Globally retrieves an LX component with a path in the hierarchyfinal LXComponentLXComponent.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 LXComponentLXDeviceComponent.removeCustomRemoteControl(LXParameter parameter) protected LXComponentLXComponent.removeParameter(LXParameter parameter) Removes a parameter from the component.protected LXComponentLXComponent.removeParameter(LXParameter parameter, boolean disposeModulations) protected LXComponentLXComponent.removeParameter(String path) Removes a parameter from the component.protected LXComponentLXComponent.removeParameter(String path, boolean removeModulations) Removes a parameter from the component.protected LXComponentLXComponent.setDescription(String description) protected final LXComponentLXComponent.setParent(LXComponent parent) Registers this component with a parent object in the hierarchy.Methods in heronarts.lx with parameters of type LXComponentModifier and TypeMethodDescriptionprotected LXDeviceComponentLXDeviceComponent.addAutomationChild(String path, LXComponent child) Adds a child to this device which can receive automation coming from snapshots or clip lanesprotected LXComponentLXComponent.addChild(String path, LXComponent child) Registers a child component with this component.static voidLXComponent.assertDisposed(LXComponent component) A checked version of dispose used by internal engine implementation to ensure that the base class LXComponent.dispose() is always called.protected LXComponentLXComponent.copyParameters(LXComponent that) Utility method to copy all parameter values from another component.static voidLX.dispose(LXComponent component) Dispose of a component, with an assertion that the disposal succeeds and the base class LXComponent.dispose() method was called.static LXPathLXPath.get(LXComponent root, String path) Globally retrieves an LX parameter at a certain scope in the LX hierarchydefault StringLXPath.getCanonicalLabel(LXComponent root) Returns the canonical user-facing label of this component.default StringLXPath.getCanonicalLabel(LXComponent root, int limit) Returns the canonical user-facing label of this component.default StringLXPath.getCanonicalLabel(LXComponent root, String separator) default StringLXPath.getCanonicalLabel(LXComponent root, String separator, int limit) Returns the canonical user-facing label of this component.default StringLXPath.getCanonicalPath(LXComponent root) Gets the canonical path of a Path object up to a given rootstatic LXComponentLXPath.getComponent(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchystatic StringLXComponent.getComponentName(LXComponent component, String suffix) Gets the name of an LXComponent object with suffix removedstatic LXParameterLXPath.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 booleanLXPath.isDescendant(LXComponent root) Determines whether this path object is a descendant of a root componentprotected static voidLXComponent.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 LXComponentLXComponent.setParent(LXComponent parent) Registers this component with a parent object in the hierarchy.static JsonObjectLXSerializable.Utils.toObject(LXComponent component) Serializes an LXComponent to a JsonObjectstatic JsonObjectLXSerializable.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 pathMethod parameters in heronarts.lx with type arguments of type LXComponentModifier and TypeMethodDescriptionprotected LXComponentLXComponent.addArray(String path, List<? extends LXComponent> childArray) Registers an array of subcomponents with this component.booleanLX.canInstantiate(Class<? extends LXComponent> clz) static StringLXComponent.getCategory(Class<? extends LXComponent> clazz) static StringLXComponent.getComponentDescription(Class<? extends LXComponent> cls) Gets the description for a component class, if one is available and provided by the description annotationstatic StringLXComponent.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 StringLXComponent.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.audioModifier and TypeClassDescriptionclassImplementation of Audio Definition Model data.classclassclassA frequency gate monitors a Graphic Meter for a particular frequency range and triggers when that range passes a certain threshold.classA DecibelMeter is a modulator that returns the level of an audio signal.classclassprotected classclassclassA graphic meter splits the signal into frequency bands and computes envelopes for each of the bands independently.classclassclassclassclassclassclassclass -
Uses of LXComponent in heronarts.lx.blend
Subclasses of LXComponent in heronarts.lx.blendModifier and TypeClassDescriptionclassclassclassclassclassThe dissolve blend is a special blend used in the crossfader.classclassclassclassAn LXBlend is a loop-based implementation of a compositing algorithm.static classclassclassclassclassclassMethods in heronarts.lx.blend with parameters of type LXComponent -
Uses of LXComponent in heronarts.lx.clip
Subclasses of LXComponent in heronarts.lx.clipModifier and TypeClassDescriptionclassclassclassclassstatic classclassLXClipLane<T extends LXClipEvent<?>>classclassclassclassstatic classstatic classstatic classstatic classclassFields in heronarts.lx.clip declared as LXComponentMethods in heronarts.lx.clip that return LXComponentModifier and TypeMethodDescriptionLXClipEngine.addControlSurface(MixerSurface surface) LXClipEngine.removeControlSurface(MixerSurface surface) Methods in heronarts.lx.clip with parameters of type LXComponentModifier and TypeMethodDescriptionLXClip.findClipLanes(LXComponent component) protected voidLXClip.registerComponent(LXComponent component) protected voidLXClip.unregisterComponent(LXComponent component) -
Uses of LXComponent in heronarts.lx.clipboard
Classes in heronarts.lx.clipboard with type parameters of type LXComponentMethods in heronarts.lx.clipboard that return types with arguments of type LXComponentModifier and TypeMethodDescriptionClass<? extends LXComponent> LXClipboardComponent.getComponentClass() -
Uses of LXComponent in heronarts.lx.color
Subclasses of LXComponent in heronarts.lx.colorModifier and TypeClassDescriptionclassA 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.classA palette is an object that is used to keep track of top-level color values and set modes of color computation.classA 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 LXComponentModifier and TypeClassDescriptionstatic classLXCommand.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 LXComponentModifier and TypeMethodDescriptionprotected voidLXCommand.RemoveComponent.removeClipLanes(LXBus bus, LXComponent component) protected voidLXCommand.RemoveComponent.removeModulationMappings(LXModulationEngine modulation, LXComponent component) protected voidLXCommand.RemoveComponent.removeSnapshotViews(LXSnapshotEngine snapshots, LXComponent component) Constructors in heronarts.lx.command with parameters of type LXComponentModifierConstructorDescriptionAddEffect(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) ReloadEffect(LXComponent container, LXEffect effect) protectedRemoveComponent(LXComponent component) RemoveEffect(LXComponent container, LXEffect effect) -
Uses of LXComponent in heronarts.lx.dmx
Subclasses of LXComponent in heronarts.lx.dmxModifier and TypeClassDescriptionclassAbstract DMX Modulator specifying a universe, channel, and number of bytes.classExtracts a color from three DMX channels starting at a given address.classA 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.classclass -
Uses of LXComponent in heronarts.lx.effect
Subclasses of LXComponent in heronarts.lx.effectModifier and TypeClassDescriptionclassclassclassclassclassclassclassClass to represent an effect that may be applied to the color array.static classPlaceholder pattern for when a class is missingclassLXModelEffect<T extends LXModel>Deprecated.No longer recommended, does not play nicely with dynamic models and view selectionclassclass -
Uses of LXComponent in heronarts.lx.effect.audio
Subclasses of LXComponent in heronarts.lx.effect.audio -
Uses of LXComponent in heronarts.lx.effect.color
Subclasses of LXComponent in heronarts.lx.effect.colorModifier and TypeClassDescriptionclassclassclass -
Uses of LXComponent in heronarts.lx.effect.image
Subclasses of LXComponent in heronarts.lx.effect.image -
Uses of LXComponent in heronarts.lx.effect.midi
Subclasses of LXComponent in heronarts.lx.effect.midi -
Uses of LXComponent in heronarts.lx.midi
Subclasses of LXComponent in heronarts.lx.midiMethods in heronarts.lx.midi with parameters of type LXComponentModifier and TypeMethodDescriptionLXMidiEngine.findMappings(LXComponent component) LXMidiEngine.removeMappings(LXComponent component) Called when a component is disposed. -
Uses of LXComponent in heronarts.lx.midi.surface
Subclasses of LXComponent in heronarts.lx.midi.surfaceModifier and TypeClassDescriptionclassclassclassclassclassclassclassDJM-A9 INSTRUCTIONS On the mixer, under My Settings > MIDI: -Button Type MUST be set to "Toggle".classclassclass -
Uses of LXComponent in heronarts.lx.midi.template
Subclasses of LXComponent in heronarts.lx.midi.templateModifier and TypeClassDescriptionclassclassclassclassA MIDI template is a component that holds parameters for a known MIDI device, which does not implement a full MIDI surface implementation, but rather just exposes those parameters for modulation mapping via the UI.class -
Uses of LXComponent in heronarts.lx.mixer
Subclasses of LXComponent in heronarts.lx.mixerModifier and TypeClassDescriptionclassAbstract subclass for both groups and channelsclassAbstract representation of a channel, which could be a normal channel with patterns or the master channel.classA channel is a single component of the engine that has a set of patterns from which it plays and rotates.classclassRepresents the master channel.classEncapsulation of all the LX channel blending and mixerMethods in heronarts.lx.mixer with parameters of type LXComponentModifier and TypeMethodDescriptionLXBlend[]LXMixerEngine.instantiateChannelBlends(LXComponent context) -
Uses of LXComponent in heronarts.lx.modulation
Subclasses of LXComponent in heronarts.lx.modulationModifier and TypeClassDescriptionclassclassclassclassMethods in heronarts.lx.modulation with parameters of type LXComponentModifier 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
Subclasses of LXComponent in heronarts.lx.modulatorModifier and TypeClassDescriptionclassAn accelerator is a free-running modulator that changes its value based on velocity and acceleration, measured in units/second and units/second^2, respectively.classAn accumulator oscillates between increasing and decreasing value by some velocity such that it never overflows or stops moving outside of the floating point range.classclassclassA click is a simple modulator that fires a value of 1 every time its period has passed.classclassclassA modulator that tracks the value of a parameter but damps motion over time according to rules.classModulator that provides randomization within normalized value range.classclassAn extendable modulator class that lets a custom normalized function be supplied by simply extending this class and supplying a compute() and invert() method.classclassModulator that provides randomized triggering on an intervalclassThis modulator is a simple linear ramp from one value to another over a specified number of milliseconds.classclassA Modulator is an abstraction for a variable with a value that varies over time, such as an envelope or a low frequency oscillator.static classPlaceholder pattern for when a class is missingclassAn LXPeriodicModulator is a modulator that moves through a cycle in a given amount of time.classUtility subclass for modulators which oscillate in a range of values between a minimum and a maximum.classclassclassclassclassclassclassclassclassModulator that provides random noise outputclassclassA quadratic envelope moves from one value to another along a quadratic curve.classclassModulator that provides randomization within normalized value range.classA sawtooth LFO oscillates from one extreme value to another.classclassA classic sinusoidal oscillator.classclassclassSimple square wave LFO.classclassclassclassclassA triangular LFO is a simple linear modulator that oscillates between a low and hi value over a specified time period.classA sawtooth LFO oscillates from one extreme value to another.Methods in heronarts.lx.modulator with parameters of type LXComponent -
Uses of LXComponent in heronarts.lx.osc
Subclasses of LXComponent in heronarts.lx.oscModifier and TypeClassDescriptionclassstatic classAn OSC input connectionstatic classAn OSC output connectionclass -
Uses of LXComponent in heronarts.lx.output
Subclasses of LXComponent in heronarts.lx.outputModifier and TypeClassDescriptionclassclassclassDistributed Display Protocol is a simple protocol developed by 3waylabs.classDDPOutput 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.classclassA datagram implementing the Kinet protocol, used by Color Kinetics devices.classclassclassThis class represents the output stage from the LX engine to real devices.classSimple concrete output class which does nothing but group its children.classclassUDP implementation of http://openpixelcontrol.org/classTCP/IP streaming socket implementation of http://openpixelcontrol.org/classStreaming 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 LXComponentModifier and TypeMethodDescriptionFixedParameter.getParent()FunctionalParameter.getParent()LXListenableParameter.getParent()NormalizedParameter.getParent()Methods in heronarts.lx.parameter with parameters of type LXComponentModifier 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
Subclasses of LXComponent in heronarts.lx.patternModifier and TypeClassDescriptionclassclassDeprecated.classLXModelPattern<T extends LXModel>Deprecated.No longer recommended, does not play nicely with dynamic models and view selectionclassA pattern is the core object that the animation engine uses to generate colors for all the points.static classPlaceholder pattern for when a class is missing -
Uses of LXComponent in heronarts.lx.pattern.audio
Subclasses of LXComponent in heronarts.lx.pattern.audio -
Uses of LXComponent in heronarts.lx.pattern.color
Subclasses of LXComponent in heronarts.lx.pattern.colorModifier and TypeClassDescriptionclassclassclass -
Uses of LXComponent in heronarts.lx.pattern.form
Subclasses of LXComponent in heronarts.lx.pattern.formModifier and TypeClassDescriptionclassclassclassclassclass -
Uses of LXComponent in heronarts.lx.pattern.image
Subclasses of LXComponent in heronarts.lx.pattern.imageModifier and TypeClassDescriptionclassstatic classclassclass -
Uses of LXComponent in heronarts.lx.pattern.strip
Subclasses of LXComponent in heronarts.lx.pattern.strip -
Uses of LXComponent in heronarts.lx.pattern.test
Subclasses of LXComponent in heronarts.lx.pattern.testModifier and TypeClassDescriptionclassBraindead 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 -
Uses of LXComponent in heronarts.lx.scheduler
Subclasses of LXComponent in heronarts.lx.scheduler -
Uses of LXComponent in heronarts.lx.script
Subclasses of LXComponent in heronarts.lx.script -
Uses of LXComponent in heronarts.lx.snapshot
Subclasses of LXComponent in heronarts.lx.snapshotModifier and TypeClassDescriptionclassclassA snapshot holds a memory of the state of the program at a point in time.classA snapshot holds a memory of the state of the program at a point in time.classThe snapshot engine stores snapshots in time of the state of project settings.Methods in heronarts.lx.snapshot with parameters of type LXComponentModifier and TypeMethodDescriptionprotected voidLXSnapshot.addDeviceChildView(LXSnapshot.ViewScope scope, LXComponent component) LXSnapshotEngine.findSnapshotViews(LXComponent component) Find all snapshot views that involve the selected component.protected booleanLXSnapshot.ActivePatternView.isDependentOf(LXComponent component) protected booleanLXSnapshot.ChannelFaderView.isDependentOf(LXComponent component) protected booleanLXSnapshot.ParameterView.isDependentOf(LXComponent component) protected abstract booleanLXSnapshot.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 snapshotsvoidLXSnapshotEngine.removeSnapshotViews(LXComponent component) Remove all snapshot views that reference the given componentConstructors in heronarts.lx.snapshot with parameters of type LXComponent -
Uses of LXComponent in heronarts.lx.structure
Subclasses of LXComponent in heronarts.lx.structureModifier and TypeClassDescriptionclassclassclassclassClass that represents a basic fixture with a fixed number of points, no hierarchy, and that is addressed with a single output definitionclassAn LXFixture is a rich LXComponent representing a physical lighting fixture which may be addressed by output packets.classUtility base class that adds a bunch of parameters to a fixture object for selection of the most common protocols.classclassclassclassclassclassMethods in heronarts.lx.structure that return LXComponentModifier and TypeMethodDescriptionprotected LXComponentLXFixture.addParameter(String path, LXParameter parameter) -
Uses of LXComponent in heronarts.lx.structure.view
Subclasses of LXComponent in heronarts.lx.structure.view -
Uses of LXComponent in heronarts.lx.studio.ui
Methods in heronarts.lx.studio.ui with parameters of type LXComponentModifier and TypeMethodDescriptionUIContentPicker.setTarget(LXComponent target, boolean effectsOnly) voidUIContentPicker.show(LXStudio.UI ui, UI2dComponent source, LXComponent target, Event event) voidUIContentPicker.show(LXStudio.UI ui, UI2dComponent source, LXComponent target, Event event, boolean effectsOnly) voidUIContentPicker.show(LXStudio.UI ui, UI2dComponent source, LXComponent target, Event event, boolean effectsOnly, boolean above, boolean left) -
Uses of LXComponent in heronarts.lx.studio.ui.device
Fields in heronarts.lx.studio.ui.device declared as LXComponentMethods in heronarts.lx.studio.ui.device with parameters of type LXComponentModifier and TypeMethodDescriptionprotected voidUIDevice.addContentPicker(LXStudio.UI ui, LXComponent target) Constructors in heronarts.lx.studio.ui.device with parameters of type LXComponentModifierConstructorDescriptionprotectedUIDevice(LXStudio.UI ui, LXComponent component, float contentWidth) UIEffectDevice(LXStudio.UI ui, LXComponent parent, LXEffect effect) protectedUIPresetDevice(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 LXComponentModifier and TypeFieldDescriptionfinal LXComponentUIAbstractGlobalModulator.componentprotected final LXComponentUIModulator.modulatorConstructors in heronarts.lx.studio.ui.modulation with parameters of type LXComponentModifierConstructorDescriptionUIAbstractGlobalModulator(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) UIModulationMappings(UI ui, LXComponent component, LXModulator modulator, float x, float y, float w, float h) protectedUIModulator(UI ui, LXComponent modulator, float x, float y, float w, float h)