heronarts.lx

Interface LXPath

All Known Subinterfaces:

LXNormalizedParameter, LXParameter

All Known Implementing Classes:

Accelerator, Accumulator, AddBlend, ADEnvelope, ADSREnvelope, ArcFixture, ArtNetDatagram, ArtSyncDatagram, BandGate, BlurEffect, BooleanParameter, BoundedFunctionalParameter, BoundedParameter, Click, ColorizeEffect, ColorParameter, CompoundParameter, DampedParameter, DarkestBlend, DDPDatagram, DDPOutputGroup, DecibelMeter, DifferenceBlend, DiscreteColorParameter, DiscreteParameter, DissolveBlend, DynamicsEffect, EnumParameter, FadecandySocket, FixedParameter, FunctionalModulator, FunctionalParameter, GateEffect, GradientPattern, GraphicEqualizerPattern, GraphicMeter, GridFixture, HistoryBuffer, HueSaturationEffect, InvertEffect, JsonFixture, KinetDatagram, LifePattern, LightestBlend, LinearEnvelope, LXAbstractChannel, LXAbstractChannelClip, LXAudioComponent, LXAudioEngine, LXAudioInput, LXAudioOutput, LXBasicFixture, LXBlend, LXBlend.FunctionalBlend, LXBufferOutput, LXBus, LXChannel, LXChannelClip, LXClip, LXClipEngine, LXClipEngine.FocusedClipParameter, LXComponent, LXCompoundModulation, LXDatagram, LXDeviceComponent, LXDynamicColor, LXEffect, LXEffect.Placeholder, LXEngine, LXEngine.Output, LXFixture, LXGroup, LXGroupClip, LXLayer, LXLayeredComponent, LXListenableNormalizedParameter, LXListenableParameter, LXMasterBus, LXMasterClip, LXMidiEngine, LXMixerEngine, LXModelComponent, LXModelEffect, LXModelLayer, LXModelPattern, LXModulationEngine, LXModulator, LXModulatorComponent, LXOscEngine, LXOutput, LXOutputGroup, LXPalette, LXParameterModulation, LXPattern, LXPattern.Placeholder, LXPeriodicModulator, LXProtocolFixture, LXRangeModulator, LXRunnableComponent, LXScheduledProject, LXScheduler, LXSnapshot, LXSnapshotEngine, LXSocket, LXStructure, LXStructure.Output, LXSwatch, LXTriggerModulation, LXVirtualParameter, MacroKnobs, MultiplyBlend, MultiStageEnvelope, MutableParameter, NoisePattern, NormalBlend, NormalizedParameter, ObjectParameter, OPCDatagram, OPCSocket, P3LXPattern, PlanesPattern, PlanesPattern.Plane, PointFixture, QuadraticEnvelope, SawLFO, ScreenBlend, SinLFO, SolidPattern, SparkleEffect, SparklePattern, SquareLFO, StreamingACNDatagram, StringParameter, StripFixture, StrobeEffect, SubtractBlend, Tempo, TestPattern, TriangleLFO, VariableLFO

public interface LXPath

Interface for any object in the LX system that can be represented by an abstract path. Typcially this is an LXComponent or an LXParameter

Method Summary

Modifier and Type	Method and Description
static LXPath	get(LXComponent root, String path) Globally retrieves an LX parameter at a certain scope in the LX hierarchy
static LXPath	get(LX lx, String path) Globally retrieves an LX object with a path in the hierarchy
default String	getCanonicalLabel() Returns the canonical user-facing label of this object.
default String	getCanonicalLabel(LXComponent root) Returns the canonical user-facing label of this component.
default String	getCanonicalPath() Gets the canonical path of a Path object all the way up its chain
default String	getCanonicalPath(LXComponent root) Gets the canonical path of a Path object up to a given root
static LXComponent	getComponent(LXComponent root, String path) Globally retrieves an LX component at a certain scope in the LX hierarchy
static LXComponent	getComponent(LX lx, String path) Globally retrieves an LX component with a path in the hierarchy
String	getLabel() Returns the user-facing label of this component
static LXParameter	getParameter(LXComponent root, String path) Globally retrieves an LX parameter at a certain scope in the LX hierarchy
static LXParameter	getParameter(LX lx, String path) Globally retrieves an LX parameter with a path in the hierarchy
LXComponent	getParent() Returns the component that this object belongs to
String	getPath() Returns the immediate path of this component, relative to its parent

Method Detail

getPath

String getPath()

Returns the immediate path of this component, relative to its parent

Returns:

Path of this object relative to its parent component

getLabel

String getLabel()

Returns the user-facing label of this component

Returns:

User-facing label for this component

getParent

LXComponent getParent()

Returns the component that this object belongs to

Returns:

Parent component of this path object, or null if it is unowned

getCanonicalPath

default String getCanonicalPath(LXComponent root)

Gets the canonical path of a Path object up to a given root

Parameters:

root - Root component

Returns:

Canonical path

getCanonicalPath

default String getCanonicalPath()

Gets the canonical path of a Path object all the way up its chain

Returns:

Canonical path

getCanonicalLabel

default String getCanonicalLabel()

Returns the canonical user-facing label of this object. The label is different from the path, it's a human-readable name that takes into account how the user may have re-labeled components.

Returns:

Canonical label for this component

getCanonicalLabel

default String getCanonicalLabel(LXComponent root)

Returns the canonical user-facing label of this component. The label is different from the path, it's a human-readable name that takes into account how the user may have re-labeled components.

Parameters:

root - Root object to get label relative to

Returns:

Canonical label for this component

get

static LXPath get(LX lx,
                  String path)

Globally retrieves an LX object with a path in the hierarchy

Parameters:

lx - LX instance

path - Canonical path of object

Returns:

Object at the given canonical path

getComponent

static LXComponent getComponent(LX lx,
                                String path)

Globally retrieves an LX component with a path in the hierarchy

Parameters:

lx - LX instance

path - Canonical path of object

Returns:

Object at the given canonical path, if it is an LXComponent

getParameter

static LXParameter getParameter(LX lx,
                                String path)

Globally retrieves an LX parameter with a path in the hierarchy

Parameters:

lx - LX instance

path - Canonical path of object

Returns:

Object at the given canonical path, if it is an LXParameter

get

static LXPath get(LXComponent root,
                  String path)

Globally retrieves an LX parameter at a certain scope in the LX hierarchy

Parameters:

root - LX root scope

path - Canonical path of object

Returns:

Object at the given canonical path

getComponent

static LXComponent getComponent(LXComponent root,
                                String path)

Globally retrieves an LX component at a certain scope in the LX hierarchy

Parameters:

root - LX root scope

path - Canonical path of object

Returns:

Object at the given canonical path, if an LXComponent

getParameter

static LXParameter getParameter(LXComponent root,
                                String path)

Globally retrieves an LX parameter at a certain scope in the LX hierarchy

Parameters:

root - LX root scope

path - Canonical path of object

Returns:

Object at the given canonical path, if an LXParameter