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 and Description
class	JsonFixture.ParameterDefinition
static class	JsonFixture.ParameterType

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

LXFixture.DynamicIndexBuffer, LXFixture.IndexBufferSegment, LXFixture.Protocol, LXFixture.Submodel

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
BooleanParameter	error
StringParameter	errorMessage
MutableParameter	parametersReloaded
BoundedParameter	scale
BooleanParameter	warning
List<String>	warnings

Fields inherited from class heronarts.lx.structure.LXFixture

brightness, children, enabled, identify, mute, NO_SUBMODELS, outputs, pitch, points, roll, selected, solo, x, y, yaw, z

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

Constructor and Description
JsonFixture(LX lx)
JsonFixture(LX lx, String fixtureType)

Method Summary

Modifier and Type	Method and Description
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	computeGeometryMatrix(LXMatrix geometryMatrix) Subclasses may override this if they perform geometric transformations in a different order or using totally different parameters.
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.
Collection<JsonFixture.ParameterDefinition>	getJsonParameters()
protected Map<String,String>	getMetaData() Subclasses may override to provide a map of String key/value pairs that are attached as metadata onto the resulting LXModel object
protected String[]	getModelKeys() Subclasses may override to return an array of multiple key types.
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.
protected LXFixture.Submodel[]	toSubmodels() Subclasses may override when they specify submodels

Methods inherited from class heronarts.lx.structure.LXFixture

addChild, addGeometryParameter, addMetricsParameter, addOutput, addOutputParameter, addParameter, beforeRegenerate, constructModel, constructPoint, copyPoint, dispose, fixtureGenerationChanged, fixtureGeometryChanged, getFirstPointIndex, getGeometryMatrix, getGeometryMatrix, getIndex, getIndexBufferOffset, getModelKey, getPath, regenerate, reindexOutputs, removeChild, removeOutput, setStructure, toDynamicIndexBuffer, toDynamicIndexBuffer, toDynamicIndexBuffer, toDynamicIndexBuffer, totalSize

Methods inherited from class heronarts.lx.LXComponent

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

scale

public final BoundedParameter scale

error

public final BooleanParameter error

errorMessage

public final StringParameter errorMessage

warning

public final BooleanParameter warning

parametersReloaded

public final MutableParameter parametersReloaded

warnings

public final List<String> warnings

Constructor Detail

JsonFixture

public JsonFixture(LX lx)

JsonFixture

public JsonFixture(LX lx,
                   String fixtureType)

Method Detail

getModelKeys

protected String[] getModelKeys()

Description copied from class: LXFixture

Subclasses may override to return an array of multiple key types.

Overrides:

getModelKeys in class LXFixture

Returns:

List of model key types for this fixture

getMetaData

protected Map<String,String> getMetaData()

Description copied from class: LXFixture

Subclasses may override to provide a map of String key/value pairs that are attached as metadata onto the resulting LXModel object

Overrides:

getMetaData in class LXFixture

Returns:

Map of key-value String pairs, or null if none

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

getJsonParameters

public Collection<JsonFixture.ParameterDefinition> getJsonParameters()

reload

public void reload()

computeGeometryMatrix

protected void computeGeometryMatrix(LXMatrix geometryMatrix)

Description copied from class: LXFixture

Subclasses may override this if they perform geometric transformations in a different order or using totally different parameters. The supplied parameter is a mutable matrix which will initially hold the value of the parent transformation matrix. It can then be further manipulated based upon the parameters.

Overrides:

computeGeometryMatrix in class LXFixture

Parameters:

geometryMatrix - The geometry transformation matrix for this object

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

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.addOutput(LXOutput) for each output.

Specified by:

buildOutputs in class LXFixture

toSubmodels

protected LXFixture.Submodel[] toSubmodels()

Description copied from class: LXFixture

Subclasses may override when they specify submodels

Overrides:

toSubmodels in class LXFixture

Returns:

Array of submodel objects

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

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