heronarts.lx.structure

Class LXStructure

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.structure.LXStructure

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener, LXFixtureContainer

public class LXStructure
extends LXComponent
implements LXFixtureContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LXStructure.Listener Listener interface for the top-level structure
static interface	LXStructure.ModelListener Implementation-only interface to relay model changes back to the core LX instance.
class	LXStructure.Output

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
List<LXFixture>	fixtures
BooleanParameter	isStatic
StringParameter	modelName
LXStructure.Output	output
BooleanParameter	syncModelFile

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
LXStructure(LX lx)
LXStructure(LX lx, LXModel immutable)

Method Summary

Modifier and Type	Method and Description
LXStructure	addFixture(LXFixture fixture)
LXStructure	addFixture(LXFixture fixture, int index)
LXStructure	addListener(LXStructure.Listener listener)
LXStructure	adjustSelectedFixtureBrightness(float delta)
LXStructure	enableSelectedFixtures(boolean enabled)
LXStructure	exportModel(File file)
void	fixtureGenerationChanged(LXFixture fixture) The generation of this fixture has changed, its metrics or hierarchy are now different.
void	fixtureGeometryChanged(LXFixture fixture) The geometry of this fixture has changed, its metrics and hierarchy are consistent but the point locations may have changed.
LXModel	getModel()
File	getModelFile()
String	getPath() Accessor for the path of this object.
List<LXFixture>	getSelectedFixtures()
LXStructure	identifySelectedFixtures(boolean identify)
LXStructure	importModel(File file)
void	load(LX lx, JsonObject obj) Loads the LX component.
LXStructure	moveFixture(LXFixture fixture, int index)
LXStructure	newDynamicModel()
LXStructure	removeFixture(LXFixture fixture)
LXStructure	removeFixtures(List<LXFixture> fixtures)
LXStructure	removeListener(LXStructure.Listener listener)
LXStructure	removeSelectedFixtures()
LXStructure	rotateSelectedFixtures(float theta, float phi)
LXStructure	rotateSelectedFixtures(float theta, float phi, LXCommand.Structure.ModifyFixturePositions action)
void	save(LX lx, JsonObject obj) Serializes the LX component.
LXStructure	selectAllFixtures()
LXStructure	selectFixture(LXFixture fixture)
LXStructure	selectFixture(LXFixture fixture, boolean isMultipleSelection)
LXStructure	selectFixtureRange(LXFixture fixture)
void	setModelListener(LXStructure.ModelListener listener) Internal implementation-only helper to set a listener for notification on changes to the structure's model.
LXStructure	setStaticModel(LXModel model)
LXStructure	soloFixture(LXFixture fixture)
LXStructure	translateSelectedFixtures(float tx, float ty, float tz)
LXStructure	translateSelectedFixtures(float tx, float ty, float tz, LXCommand.Structure.ModifyFixturePositions action)

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, handleOscMessage, loadParameters, onParameterChanged, 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

modelName

public final StringParameter modelName

isStatic

public final BooleanParameter isStatic

syncModelFile

public final BooleanParameter syncModelFile

fixtures

public final List<LXFixture> fixtures

output

public final LXStructure.Output output

Constructor Detail

LXStructure

public LXStructure(LX lx)

LXStructure

public LXStructure(LX lx,
                   LXModel immutable)

Method Detail

setModelListener

public void setModelListener(LXStructure.ModelListener listener)

Internal implementation-only helper to set a listener for notification on changes to the structure's model. This is used by the LX class to relay model-changes from the structure back to the top-level LX object while keeping that functionality private on the core LX API.

Parameters:

listener - Listener

getPath

public String getPath()

Description copied from class: LXComponent

Accessor for the path of this object. Returns the path this component was registered with. Some subclasses may override this if path structure is dynamic.

Specified by:

getPath in interface LXPath

Overrides:

getPath in class LXComponent

Returns:

path of this component relative to its parent

getModelFile

public File getModelFile()

getModel

public LXModel getModel()

addListener

public LXStructure addListener(LXStructure.Listener listener)

removeListener

public LXStructure removeListener(LXStructure.Listener listener)

addFixture

public LXStructure addFixture(LXFixture fixture)

addFixture

public LXStructure addFixture(LXFixture fixture,
                              int index)

moveFixture

public LXStructure moveFixture(LXFixture fixture,
                               int index)

selectFixtureRange

public LXStructure selectFixtureRange(LXFixture fixture)

selectAllFixtures

public LXStructure selectAllFixtures()

selectFixture

public LXStructure selectFixture(LXFixture fixture)

selectFixture

public LXStructure selectFixture(LXFixture fixture,
                                 boolean isMultipleSelection)

soloFixture

public LXStructure soloFixture(LXFixture fixture)

getSelectedFixtures

public List<LXFixture> getSelectedFixtures()

removeFixtures

public LXStructure removeFixtures(List<LXFixture> fixtures)

removeSelectedFixtures

public LXStructure removeSelectedFixtures()

removeFixture

public LXStructure removeFixture(LXFixture fixture)

translateSelectedFixtures

public LXStructure translateSelectedFixtures(float tx,
                                             float ty,
                                             float tz)

translateSelectedFixtures

public LXStructure translateSelectedFixtures(float tx,
                                             float ty,
                                             float tz,
                                             LXCommand.Structure.ModifyFixturePositions action)

rotateSelectedFixtures

public LXStructure rotateSelectedFixtures(float theta,
                                          float phi)

rotateSelectedFixtures

public LXStructure rotateSelectedFixtures(float theta,
                                          float phi,
                                          LXCommand.Structure.ModifyFixturePositions action)

adjustSelectedFixtureBrightness

public LXStructure adjustSelectedFixtureBrightness(float delta)

enableSelectedFixtures

public LXStructure enableSelectedFixtures(boolean enabled)

identifySelectedFixtures

public LXStructure identifySelectedFixtures(boolean identify)

newDynamicModel

public LXStructure newDynamicModel()

setStaticModel

public LXStructure setStaticModel(LXModel model)

fixtureGenerationChanged

public void fixtureGenerationChanged(LXFixture fixture)

Description copied from interface: LXFixtureContainer

The generation of this fixture has changed, its metrics or hierarchy are now different. The container will need to take this into account.

Specified by:

fixtureGenerationChanged in interface LXFixtureContainer

Parameters:

fixture - Fixture that has changed

fixtureGeometryChanged

public void fixtureGeometryChanged(LXFixture fixture)

Description copied from interface: LXFixtureContainer

The geometry of this fixture has changed, its metrics and hierarchy are consistent but the point locations may have changed.

Specified by:

fixtureGeometryChanged in interface LXFixtureContainer

Parameters:

fixture - Fixture that has changed

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 LXComponent

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

importModel

public LXStructure importModel(File file)

exportModel

public LXStructure exportModel(File file)