Package heronarts.lx.structure

Class GridFixture

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.structure.LXFixture

heronarts.lx.structure.LXProtocolFixture

heronarts.lx.structure.LXBasicFixture

heronarts.lx.structure.GridFixture

All Implemented Interfaces:

LXComponent.Renamable, LXPath, LXSerializable, LXParameterListener, LXFixtureContainer

@LXCategory("Core")
public class GridFixture
extends LXBasicFixture

Nested Class Summary

Nested Classes

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

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.Hidden, LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BoundedParameter	columnSpacing
final StringParameter	columnTags
final DiscreteParameter	numColumns
final DiscreteParameter	numRows
final EnumParameter<GridFixture.PositionMode>	positionMode
final BoundedParameter	rowSpacing
final StringParameter	rowTags
final EnumParameter<GridFixture.Wiring>	wiring

Fields inherited from class heronarts.lx.structure.LXProtocolFixture

artNetSequenceEnabled, artNetUniverse, byteOrder, ddpDataOffset, dmxChannel, host, kinetPort, kinetVersion, opcChannel, opcOffset, port, protocol, reverse, sacnPriority, transport, unknownHost

Fields inherited from class heronarts.lx.structure.LXFixture

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

Fields inherited from class heronarts.lx.LXComponent

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

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
GridFixture(LX lx)

Method Summary

Modifier and Type	Method	Description
void	addModelMetaData(Map<String,String> metaData)	Subclasses may override to add additiona metadata fields for inclusion in the model
protected LXFixture.Segment	buildSegment()
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[]	getDefaultTags()	Subclasses may override to return an array of default tag types for this fixture in the model hierarchy
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.LXBasicFixture

buildOutputs

Methods inherited from class heronarts.lx.structure.LXProtocolFixture

getProtocolChannel, getProtocolKinetVersion, getProtocolPort, getProtocolPriority, getProtocolSequenceEnabled, getProtocolTransport, getProtocolUniverse, resolveHostAddress

Methods inherited from class heronarts.lx.structure.LXFixture

addChild, addGeometryParameter, addMetricsParameter, addOutputDefinition, addOutputDirect, addOutputParameter, addParameter, addTagParameter, addTransform, beforeRegenerate, clearTransforms, computeGeometryMatrix, constructModel, constructPoint, copyPoint, dispose, fixtureGenerationChanged, fixtureGeometryChanged, fixtureOutputChanged, fixtureTagsChanged, getFirstPointIndex, getGeometryMatrix, getGeometryMatrix, getIndex, getIndexBufferOffset, getPath, load, onParameterChanged, regenerate, regenerateOutputs, reindexOutputs, removeChild, removeOutputDefinition, removeOutputDirect, setStructure, setTags, totalSize

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, 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, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

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

rowTags

public final StringParameter rowTags

columnTags

public final StringParameter columnTags

Constructor Details

GridFixture

public GridFixture(LX lx)

Method Details

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

getDefaultTags

protected String[] getDefaultTags()

Description copied from class: LXFixture

Subclasses may override to return an array of default tag types for this fixture in the model hierarchy

Overrides:

getDefaultTags in class LXFixture

Returns:

List of model tag types for this fixture

buildSegment

protected LXFixture.Segment buildSegment()

Overrides:

buildSegment in class LXBasicFixture

addModelMetaData

public 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