Package heronarts.lx.clip

Class LXClip.CursorParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.AggregateParameter

heronarts.lx.clip.LXClip.CursorParameter

All Implemented Interfaces:

LXPath, LXParameter

Enclosing class:

LXClip

public class LXClip.CursorParameter
extends AggregateParameter

Nested Class Summary

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

Modifier and Type	Field	Description
final BoundedParameter	beatBasis
final DiscreteParameter	beatCount
final LXClip	clip
final Cursor	cursor
final MutableParameter	millis

Fields inherited from class heronarts.lx.parameter.AggregateParameter

subparameters

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
CursorParameter(String label)

Method Summary

Modifier and Type	Method	Description
protected void	onSubparameterUpdate(LXParameter p)	Subclasses should update the main parameter value when a sub-parameter has changed
protected double	onUpdateValue(double value)	Subclasses may optionally override to take action based upon directly updated value
LXClip.CursorParameter	reset()	A method to reset the value of the parameter, if a default is available.
LXClip.CursorParameter	setDescription(String description)
protected void	updateSubparameters(double value)	Subclasses should update the subparameter values based upon the raw parameter value if it has been set directly.

Methods inherited from class heronarts.lx.parameter.AggregateParameter

addSubparameter, dispose, getRemoteControl, updateValue

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, setComponent, setFormatter, setMappable, setPolarity, setUnits, 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.LXParameter

getBaseValue, getBaseValuef, getValuef

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

clip

public final LXClip clip

cursor

public final Cursor cursor

millis

public final MutableParameter millis

beatCount

public final DiscreteParameter beatCount

beatBasis

public final BoundedParameter beatBasis

Constructor Details

CursorParameter

public CursorParameter(String label)

Method Details

reset

public LXClip.CursorParameter reset()

Description copied from interface: LXParameter

A method to reset the value of the parameter, if a default is available. Not necessarily defined for all parameters, may be ignored.

Specified by:

reset in interface LXParameter

Overrides:

reset in class LXListenableParameter

Returns:

this

onUpdateValue

protected double onUpdateValue(double value)

Description copied from class: AggregateParameter

Subclasses may optionally override to take action based upon directly updated value

Overrides:

onUpdateValue in class AggregateParameter

Parameters:

value - Updated value

Returns:

Value to store

updateSubparameters

protected void updateSubparameters(double value)

Description copied from class: AggregateParameter

Subclasses should update the subparameter values based upon the raw parameter value if it has been set directly.

Specified by:

updateSubparameters in class AggregateParameter

onSubparameterUpdate

protected void onSubparameterUpdate(LXParameter p)

Description copied from class: AggregateParameter

Subclasses should update the main parameter value when a sub-parameter has changed

Specified by:

onSubparameterUpdate in class AggregateParameter

Parameters:

p - Subparameter that has changed

setDescription

public LXClip.CursorParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter