heronarts.lx.structure

Class GridFixture

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.structure.LXFixture

heronarts.lx.structure.LXProtocolFixture

heronarts.lx.structure.GridFixture

All Implemented Interfaces:

LXComponent.Renamable, LXPath, LXSerializable, LXParameterListener, LXFixtureContainer

public class GridFixture
extends LXProtocolFixture

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridFixture.PositionMode
static class	GridFixture.Wiring

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

LXProtocolFixture.Transport

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
BoundedParameter	columnSpacing
DiscreteParameter	numColumns
DiscreteParameter	numRows
DiscreteParameter	pointsPerPacket
EnumParameter<GridFixture.PositionMode>	positionMode
BoundedParameter	rowSpacing
BooleanParameter	splitPacket
EnumParameter<GridFixture.Wiring>	wiring

Fields inherited from class heronarts.lx.structure.LXProtocolFixture

artNetUniverse, ddpDataOffset, host, kinetPort, opcChannel, port, protocol, reverse, transport, unknownHost

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
GridFixture(LX lx)

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	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.
protected String	getModelKey() Subclasses should implement, specifying the type key of this fixture in the model hierarchy.
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
protected void	reindexOutputs() Subclasses may override this method to update their outputs in the case that the point indexing of this fixture has changed.
protected int	size() Subclasses must implement to specify the number of points in the fixture.
LXFixture.Submodel[]	toSubmodels() Subclasses may override when they specify submodels

Methods inherited from class heronarts.lx.structure.LXProtocolFixture

getProtocolChannel, resolveHostAddress

Methods inherited from class heronarts.lx.structure.LXFixture

addChild, addGeometryParameter, addMetricsParameter, addOutput, addOutputParameter, addParameter, beforeRegenerate, computeGeometryMatrix, constructModel, constructPoint, copyPoint, dispose, fixtureGenerationChanged, fixtureGeometryChanged, getFirstPointIndex, getGeometryMatrix, getGeometryMatrix, getIndex, getIndexBufferOffset, getMetaData, getModelKeys, getPath, load, regenerate, 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, 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

numRows

public final DiscreteParameter numRows

numColumns

public final DiscreteParameter numColumns

rowSpacing

public final BoundedParameter rowSpacing

columnSpacing

public final BoundedParameter columnSpacing

positionMode

public final EnumParameter<GridFixture.PositionMode> positionMode

wiring

public final EnumParameter<GridFixture.Wiring> wiring

splitPacket

public final BooleanParameter splitPacket

pointsPerPacket

public final DiscreteParameter pointsPerPacket

Constructor Detail

GridFixture

public GridFixture(LX lx)

Method Detail

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

toSubmodels

public 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

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

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

getModelKey

protected String getModelKey()

Description copied from class: LXFixture

Subclasses should implement, specifying the type key of this fixture in the model hierarchy.

Overrides:

getModelKey in class LXFixture

Returns:

String key for the model type

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

reindexOutputs

protected void reindexOutputs()

Description copied from class: LXFixture

Subclasses may override this method to update their outputs in the case that the point indexing of this fixture has changed. Outputs may be removed and readded inside this method if necessary. If the LXFixture.DynamicIndexBuffer class has been used to construct indices for outputs, then no action should typically be necessary.

Overrides:

reindexOutputs in class LXFixture