heronarts.lx.output

Class LXOutput

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXBufferOutput, LXOutputGroup, LXStructure.Output

public abstract class LXOutput
extends LXComponent

This class represents the output stage from the LX engine to real devices. Outputs may have their own brightness, be enabled/disabled, be throttled, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXOutput.GammaMode
static interface	LXOutput.InetOutput

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

LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
CompoundParameter	brightness Brightness of the output
BooleanParameter	enabled Whether the output is enabled.
BoundedParameter	framesPerSecond Framerate throttle
BoundedParameter	gamma Gamma correction level
EnumParameter<LXOutput.GammaMode>	gammaMode Gamma table mode, whether to inherit gamma

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LXOutput(LX lx)
protected	LXOutput(LX lx, String label)

Method Summary

Modifier and Type	Method and Description
static void	error(Exception x, String message)
static void	error(String message)
protected byte[]	getGammaLut(double brightness)
static void	log(String message)
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
protected abstract void	onSend(int[] colors, byte[] glut) Subclasses implement this to send the data.
protected void	onSend(int[] colors, double brightness)
LXOutput	send(int[] colors) Sends data to this output, applying throttle and color correction
LXOutput	send(int[] colors, double brightness) Sends data to this output at the pre-corrected brightness
void	setGammaDelegate(LXOutput gammaDelegate)
void	setGroup(LXOutputGroup output)

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, dispose, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, load, loadParameters, removeParameter, removeParameter, save, saveParameters, setParent, 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

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

enabled

public final BooleanParameter enabled

Whether the output is enabled.

framesPerSecond

public final BoundedParameter framesPerSecond

Framerate throttle

gamma

public final BoundedParameter gamma

Gamma correction level

gammaMode

public final EnumParameter<LXOutput.GammaMode> gammaMode

Gamma table mode, whether to inherit gamma

brightness

public final CompoundParameter brightness

Brightness of the output

Constructor Detail

LXOutput

protected LXOutput(LX lx)

LXOutput

protected LXOutput(LX lx,
                   String label)

Method Detail

setGammaDelegate

public void setGammaDelegate(LXOutput gammaDelegate)

setGroup

public void setGroup(LXOutputGroup output)

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

send

public LXOutput send(int[] colors)

Sends data to this output, applying throttle and color correction

Parameters:

colors - Array of color values

Returns:

this

send

public final LXOutput send(int[] colors,
                           double brightness)

Sends data to this output at the pre-corrected brightness

Parameters:

colors - Color buffer

brightness - Brightness level from parent

Returns:

this

getGammaLut

protected byte[] getGammaLut(double brightness)

onSend

protected void onSend(int[] colors,
                      double brightness)

onSend

protected abstract void onSend(int[] colors,
                               byte[] glut)

Subclasses implement this to send the data.

Parameters:

colors - Color values

glut - Look-up table scaled to appropriate brightness and gamma

log

public static final void log(String message)

error

public static final void error(String message)

error

public static final void error(Exception x,
                               String message)