Package heronarts.lx.dmx

Class LXDmxEngine

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.dmx.LXDmxEngine

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

public class LXDmxEngine
extends LXComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LXDmxEngine.ByteOrder

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

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

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final TriggerParameter	artNetActivity
final BooleanParameter	artNetReceiveActive
final DiscreteParameter	artNetReceivePort
final EnumParameter<LXOscEngine.IOState>	artNetReceiveState
static final int	MAX_CHANNEL
static final int	MAX_UNIVERSE

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

Constructor	Description
LXDmxEngine(LX lx)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
static void	error(String log)
static void	error(Throwable x, String log)
byte	getByte(int universe, int channel)
int	getColor(int universe, int channel)
int	getColor(int universe, int channel, LXDmxEngine.ByteOrder byteOrder)
double	getNormalized(int universe, int channel)
int	getValuei(int universe, int channel)
void	load(LX lx, JsonObject obj)	Loads the LX component.
static void	log(String log)
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, 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

Field Details

artNetReceiveState

public final EnumParameter<LXOscEngine.IOState> artNetReceiveState

artNetReceiveActive

public final BooleanParameter artNetReceiveActive

artNetReceivePort

public final DiscreteParameter artNetReceivePort

artNetActivity

public final TriggerParameter artNetActivity

MAX_CHANNEL

public static final int MAX_CHANNEL

See Also:

• Constant Field Values

MAX_UNIVERSE

public static final int MAX_UNIVERSE

See Also:

• Constant Field Values

Constructor Details

LXDmxEngine

public LXDmxEngine(LX lx)

Method Details

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

getColor

public int getColor(int universe,
 int channel)

getColor

public int getColor(int universe,
 int channel,
 LXDmxEngine.ByteOrder byteOrder)

getByte

public byte getByte(int universe,
 int channel)

getValuei

public int getValuei(int universe,
 int channel)

getNormalized

public double getNormalized(int universe,
 int channel)

load

public void load(LX lx,
 JsonObject obj)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize

dispose

public void dispose()

Description copied from class: LXComponent

Invoked when a component is being removed from the system and will no longer be used at all. This unregisters the component and should free up any resources and parameter listeners. Ideally after this method is called the object should be eligible for garbage collection. Subclasses are generally expected to override this method to handle their particular cleanup work. They should also generally call super.dispose() at the appropriate time to perform the basic cleanup, which may need to happen either before or after cleaning up other objects.

Overrides:

dispose in class LXComponent

error

public static void error(String log)

error

public static void error(Throwable x,
 String log)

log

public static void log(String log)