Package heronarts.lx.structure.view

Class LXViewDefinition

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.structure.view.LXViewDefinition

All Implemented Interfaces:

LXComponent.Renamable, LXPath, LXSerializable, LXParameterListener

public class LXViewDefinition
extends LXComponent
implements LXComponent.Renamable

Nested Class Summary

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

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

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BooleanParameter	cueActive
final BooleanParameter	enabled
final BooleanParameter	invalidOrientation
final EnumParameter<LXView.Normalization>	normalization
final DiscreteParameter	numFixtures
final DiscreteParameter	numGroups
final EnumParameter<LXView.Orientation>	orientation
final BooleanParameter	priority
final StringParameter	selector

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, 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

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
LXViewDefinition(LX lx)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
int	getIndex()
LXModel	getModelView()
String	getPath()	Accessor for the path of this object.
LXView	getView()
void	load(LX lx, JsonObject obj)	Loads the LX component.
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, 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, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

enabled

public final BooleanParameter enabled

selector

public final StringParameter selector

normalization

public final EnumParameter<LXView.Normalization> normalization

orientation

public final EnumParameter<LXView.Orientation> orientation

priority

public final BooleanParameter priority

invalidOrientation

public final BooleanParameter invalidOrientation

numGroups

public final DiscreteParameter numGroups

numFixtures

public final DiscreteParameter numFixtures

cueActive

public final BooleanParameter cueActive

Constructor Details

LXViewDefinition

public LXViewDefinition(LX lx)

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 LXComponent

Parameters:

p - Parameter that has a value change

getIndex

public int getIndex()

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

getModelView

public LXModel getModelView()

getView

public LXView getView()

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

dispose

public void dispose()

Description copied from class: LXComponent

Invoked when a component is being removed from the system and will no longer be used at all. This unregisters the component and should free up any resources and parameter listeners. Ideally after this method is called the object should be eligible for garbage collection. Subclasses are generally expected to override this method to handle their particular cleanup work. They should also generally call super.dispose() at the appropriate time to perform the basic cleanup, which may need to happen either before or after cleaning up other objects.

Overrides:

dispose in class LXComponent