Package heronarts.lx.parameter

Class TriggerParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.BooleanParameter

heronarts.lx.parameter.TriggerParameter

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

public class TriggerParameter
extends BooleanParameter

A boolean parameter which is momentary and supports instantaneous toggling to true. Whenever the value is set to true the parameter listeners are fired, and then the value is then immediately set back to false.

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.parameter.BooleanParameter

BooleanParameter.Mode

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXNormalizedParameter

LXNormalizedParameter.OscMode

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
TriggerParameter(String label)
TriggerParameter(String label, Runnable onTrigger)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when the parameter is done being used and none of its resources are needed anymore.
TriggerParameter	onTrigger(Runnable onTrigger)
TriggerParameter	setDescription(String description)
BooleanParameter	setMode(BooleanParameter.Mode mode)
TriggerParameter	trigger()

Methods inherited from class heronarts.lx.parameter.BooleanParameter

getMode, getNormalized, getNormalizedf, getValueb, isOn, setMappable, setNormalized, setValue, toggle, updateValue

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

getExponent, getNormalizedWithModulation, getOscMode, incrementNormalized, incrementNormalized, isWrappable, setExponent, setOscMode, setUnits, setWrappable

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, getValue, incrementValue, isDefault, isMappable, removeListener, reset, reset, setComponent, setFormatter, setPolarity, setValue, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface heronarts.lx.parameter.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getValueFromNormalized

Methods inherited from interface heronarts.lx.parameter.LXParameter

getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setFormatter, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Constructor Details

TriggerParameter

public TriggerParameter(String label)

TriggerParameter

public TriggerParameter(String label,
 Runnable onTrigger)

Method Details

setDescription

public TriggerParameter setDescription(String description)

Overrides:

setDescription in class BooleanParameter

onTrigger

public TriggerParameter onTrigger(Runnable onTrigger)

trigger

public TriggerParameter trigger()

setMode

public BooleanParameter setMode(BooleanParameter.Mode mode)

Overrides:

setMode in class BooleanParameter

dispose

public void dispose()

Description copied from interface: LXParameter

Invoked when the parameter is done being used and none of its resources are needed anymore.

Specified by:

dispose in interface LXParameter

Overrides:

dispose in class LXListenableParameter