Package heronarts.lx.structure

Class JsonFixture

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.structure.LXFixture

heronarts.lx.structure.JsonFixture

All Implemented Interfaces:

LXComponent.Renamable, LXPath, LXSerializable, LXParameterListener, LXFixtureContainer

public class JsonFixture
extends LXFixture

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JsonFixture.ChildType
class	JsonFixture.ParameterDefinition
static enum	JsonFixture.ParameterType

Nested classes/interfaces inherited from class heronarts.lx.structure.LXFixture

LXFixture.OutputDefinition, LXFixture.Protocol, LXFixture.Segment, LXFixture.Submodel, LXFixture.Transform, LXFixture.Transport

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

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

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BooleanParameter	error
final StringParameter	errorMessage
protected static final String	KEY_BYTE_ORDER
protected static final String	KEY_CHANNEL
protected static final String	KEY_CHILDREN
protected static final String	KEY_COMPONENTS
protected static final String	KEY_COORDINATES
protected static final String	KEY_DDP_DATA_OFFSET
protected static final String	KEY_ENABLED
protected static final String	KEY_HOST
protected static final String	KEY_KINET_PORT
protected static final String	KEY_KINET_VERSION
protected static final String	KEY_LABEL
protected static final String	KEY_OFFSET
protected static final String	KEY_OPC_CHANNEL
protected static final String	KEY_OUTPUT
protected static final String	KEY_OUTPUTS
protected static final String	KEY_PARAMETERS
protected static final String	KEY_PITCH
protected static final String	KEY_POINT_SIZE
protected static final String	KEY_PORT
protected static final String	KEY_PRIORITY
protected static final String	KEY_PROTOCOL
protected static final String	KEY_REVERSE
protected static final String	KEY_ROLL
protected static final String	KEY_SEQUENCE_ENABLED
protected static final String	KEY_TAGS
protected static final String	KEY_TRANSPORT
protected static final String	KEY_TYPE
protected static final String	KEY_UNIVERSE
protected static final String	KEY_X
protected static final String	KEY_Y
protected static final String	KEY_YAW
protected static final String	KEY_Z
final List<LXModel.Mesh>	meshes
final MutableParameter	parametersDisposed
final MutableParameter	parametersReloaded
static final String	PATH_SEPARATOR
static final char	PATH_SEPARATOR_CHAR
protected static final String	TYPE_ARC
protected static final String	TYPE_CLASS
protected static final String	TYPE_POINT
protected static final String	TYPE_POINTS
protected static final String	TYPE_STRIP
final BooleanParameter	warning
final List<String>	warnings

Fields inherited from class heronarts.lx.structure.LXFixture

brightness, children, deactivate, DEFAULT_OUTPUT_REPEAT, DEFAULT_OUTPUT_STRIDE, enabled, hasCustomPointSize, identify, metaData, mute, NO_SUBMODELS, outputDefinitions, outputsDirect, pitch, points, pointSize, POSITION_RANGE, roll, scale, selected, solo, tagList, tags, x, y, yaw, z

Fields inherited from class heronarts.lx.LXComponent

childArrays, internalParameters, KEY_CLASS, KEY_INTERNAL, KEY_PARAMETER_PATH, 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
JsonFixture(LX lx)
JsonFixture(LX lx, String fixtureType)

Method Summary

Modifier and Type	Method	Description
protected void	addLXFFields(JsonObject obj, JsonObject parameters)
protected void	addModelMetaData(Map<String,String> metaData)	Subclasses may override to add additiona metadata fields for inclusion in the model
protected void	buildOutputs()	Subclasses must override this method to provide an implementation that produces the necessary set of outputs for this fixture to be sent.
protected void	computePointGeometry(LXMatrix matrix, List<LXPoint> points)	This method should be implemented by subclasses to generate the geometry of the fixture any time its geometry parameters have changed.
String	getFixturePath()
Collection<JsonFixture.ParameterDefinition>	getJsonParameters()
protected String	getLXFType()
protected List<LXModel.Mesh>	getModelMeshes()
void	load(LX lx, JsonObject obj)	Loads the LX component.
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
void	reload()
void	save(LX lx, JsonObject obj)	Serializes the LX component.
protected int	size()	Subclasses must implement to specify the number of points in the fixture.

Methods inherited from class heronarts.lx.structure.LXFixture

addChild, addGeometryParameter, addLXFOutputs, addMetricsParameter, addOutputDefinition, addOutputDirect, addOutputParameter, addParameter, addTagParameter, addTransform, beforeRegenerate, clearTransforms, computeGeometryMatrix, constructModel, constructPoint, copyPoint, dispose, fixtureGenerationChanged, fixtureGeometryChanged, fixtureOutputChanged, fixtureTagsChanged, getDefaultTags, getFirstPointIndex, getGeometryMatrix, getGeometryMatrix, getIndex, getIndexBufferOffset, getModel, getPath, newPositionParameter, newRotationParameter, regenerate, regenerateOutputs, reindexOutputs, removeChild, removeOutputDefinition, removeOutputDirect, setStructure, setTags, toLXFComponent, toSubmodels, totalSize

Methods inherited from class heronarts.lx.LXComponent

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

PATH_SEPARATOR

public static final String PATH_SEPARATOR

See Also:

• Constant Field Values

PATH_SEPARATOR_CHAR

public static final char PATH_SEPARATOR_CHAR

See Also:

• Constant Field Values

KEY_LABEL

protected static final String KEY_LABEL

See Also:

• Constant Field Values

KEY_TAGS

protected static final String KEY_TAGS

See Also:

• Constant Field Values

KEY_X

protected static final String KEY_X

See Also:

• Constant Field Values

KEY_Y

protected static final String KEY_Y

See Also:

• Constant Field Values

KEY_Z

protected static final String KEY_Z

See Also:

• Constant Field Values

KEY_YAW

protected static final String KEY_YAW

See Also:

• Constant Field Values

KEY_PITCH

protected static final String KEY_PITCH

See Also:

• Constant Field Values

KEY_ROLL

protected static final String KEY_ROLL

See Also:

• Constant Field Values

KEY_POINT_SIZE

protected static final String KEY_POINT_SIZE

See Also:

• Constant Field Values

KEY_COORDINATES

protected static final String KEY_COORDINATES

See Also:

• Constant Field Values

KEY_COMPONENTS

protected static final String KEY_COMPONENTS

See Also:

• Constant Field Values

KEY_CHILDREN

protected static final String KEY_CHILDREN

See Also:

• Constant Field Values

KEY_TYPE

protected static final String KEY_TYPE

See Also:

• Constant Field Values

TYPE_POINT

protected static final String TYPE_POINT

See Also:

• Constant Field Values

TYPE_POINTS

protected static final String TYPE_POINTS

See Also:

• Constant Field Values

TYPE_STRIP

protected static final String TYPE_STRIP

See Also:

• Constant Field Values

TYPE_ARC

protected static final String TYPE_ARC

See Also:

• Constant Field Values

TYPE_CLASS

protected static final String TYPE_CLASS

See Also:

• Constant Field Values

KEY_PARAMETERS

protected static final String KEY_PARAMETERS

See Also:

• Constant Field Values

KEY_OUTPUT

protected static final String KEY_OUTPUT

See Also:

• Constant Field Values

KEY_OUTPUTS

protected static final String KEY_OUTPUTS

See Also:

• Constant Field Values

KEY_ENABLED

protected static final String KEY_ENABLED

See Also:

• Constant Field Values

KEY_PROTOCOL

protected static final String KEY_PROTOCOL

See Also:

• Constant Field Values

KEY_TRANSPORT

protected static final String KEY_TRANSPORT

See Also:

• Constant Field Values

KEY_HOST

protected static final String KEY_HOST

See Also:

• Constant Field Values

KEY_PORT

protected static final String KEY_PORT

See Also:

• Constant Field Values

KEY_BYTE_ORDER

protected static final String KEY_BYTE_ORDER

See Also:

• Constant Field Values

KEY_UNIVERSE

protected static final String KEY_UNIVERSE

See Also:

• Constant Field Values

KEY_DDP_DATA_OFFSET

protected static final String KEY_DDP_DATA_OFFSET

See Also:

• Constant Field Values

KEY_KINET_PORT

protected static final String KEY_KINET_PORT

See Also:

• Constant Field Values

KEY_KINET_VERSION

protected static final String KEY_KINET_VERSION

See Also:

• Constant Field Values

KEY_OPC_CHANNEL

protected static final String KEY_OPC_CHANNEL

See Also:

• Constant Field Values

KEY_CHANNEL

protected static final String KEY_CHANNEL

See Also:

• Constant Field Values

KEY_PRIORITY

protected static final String KEY_PRIORITY

See Also:

• Constant Field Values

KEY_SEQUENCE_ENABLED

protected static final String KEY_SEQUENCE_ENABLED

See Also:

• Constant Field Values

KEY_OFFSET

protected static final String KEY_OFFSET

See Also:

• Constant Field Values

KEY_REVERSE

protected static final String KEY_REVERSE

See Also:

• Constant Field Values

error

public final BooleanParameter error

errorMessage

public final StringParameter errorMessage

warning

public final BooleanParameter warning

parametersDisposed

public final MutableParameter parametersDisposed

parametersReloaded

public final MutableParameter parametersReloaded

warnings

public final List<String> warnings

meshes

public final List<LXModel.Mesh> meshes

Constructor Details

JsonFixture

public JsonFixture(LX lx)

JsonFixture

public JsonFixture(LX lx,
 String fixtureType)

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 LXFixture

Parameters:

p - Parameter that has a value change

getFixturePath

public String getFixturePath()

getJsonParameters

public Collection<JsonFixture.ParameterDefinition> getJsonParameters()

reload

public void reload()

buildOutputs

protected void buildOutputs()

Description copied from class: LXFixture

Subclasses must override this method to provide an implementation that produces the necessary set of outputs for this fixture to be sent. The subclass should call LXFixture.addOutputDefinition(OutputDefinition) or LXFixture.addOutputDirect(LXOutput) for each output.

Specified by:

buildOutputs in class LXFixture

getModelMeshes

protected List<LXModel.Mesh> getModelMeshes()

Overrides:

getModelMeshes in class LXFixture

size

protected int size()

Description copied from class: LXFixture

Subclasses must implement to specify the number of points in the fixture. This does not include the number of points that are in children.

Specified by:

size in class LXFixture

Returns:

number of points immediately in the fixture

computePointGeometry

protected void computePointGeometry(LXMatrix matrix,
 List<LXPoint> points)

Description copied from class: LXFixture

This method should be implemented by subclasses to generate the geometry of the fixture any time its geometry parameters have changed. The correct number of points will have already been computed, and merely need to have their positions set.

Specified by:

computePointGeometry in class LXFixture

Parameters:

matrix - A transform matrix representing the fixture's position

points - The list of points that need to have their positions set

addModelMetaData

protected void addModelMetaData(Map<String,String> metaData)

Description copied from class: LXFixture

Subclasses may override to add additiona metadata fields for inclusion in the model

Overrides:

addModelMetaData in class LXFixture

Parameters:

metaData - Map to add meta-data fields to

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 LXFixture

Parameters:

lx - LX instance

obj - Object to deserialize

save

public void save(LX lx,
 JsonObject obj)

Description copied from class: LXComponent

Serializes the LX component. By default, all internal and user-facing parameters are serialized, as well as any explicitly registered child components. Note that child arrays are not serialized, or any other dynamic components. Subclasses may override to perform more saving, and are expected to call super.save(lx, obj) at the appropriate time.

Specified by:

save in interface LXSerializable

Overrides:

save in class LXComponent

Parameters:

lx - LX instance

obj - Object to serialize into

getLXFType

protected String getLXFType()

Overrides:

getLXFType in class LXFixture

addLXFFields

protected void addLXFFields(JsonObject obj,
 JsonObject parameters)

Overrides:

addLXFFields in class LXFixture