Package heronarts.lx.modulation

Class LXCompoundModulation

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.modulation.LXParameterModulation

heronarts.lx.modulation.LXCompoundModulation

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

public class LXCompoundModulation
extends LXParameterModulation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LXCompoundModulation.Listener	Listener that is fired when there is a change to the list of modulations being applied to a target parameter.
static interface	LXCompoundModulation.Target	A parameter type that can receive compound modulation.

Nested classes/interfaces inherited from class heronarts.lx.modulation.LXParameterModulation

LXParameterModulation.CircularDependencyException, LXParameterModulation.InvalidScopeException, LXParameterModulation.ModulationException

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 EnumParameter<LXParameter.Polarity>	polarity
final CompoundParameter	range
final LXNormalizedParameter	source	The source parameter for this compound modulation mapping
final LXCompoundModulation.Target	target	The target parameter that receives the compound modulation

Fields inherited from class heronarts.lx.modulation.LXParameterModulation

clr, color, enabled, index, KEY_SOURCE, KEY_TARGET, scope

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
LXCompoundModulation(LX lx, LXModulationEngine scope, JsonObject obj)
LXCompoundModulation(LXModulationEngine scope, LXNormalizedParameter source, LXCompoundModulation.Target target)

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.
double	getModulationAmount()
String	getPath()	Accessor for the path of this object.
LXParameter.Polarity	getPolarity()
LXCompoundModulation	setPolarity(LXParameter.Polarity polarity)

Methods inherited from class heronarts.lx.modulation.LXParameterModulation

getIndex, getLabel, getParameter, getTarget, save, setIndex

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, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, load, loadParameters, loadPreset, onParameterChanged, removeParameter, removeParameter, removeParameter, removeParameter, 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

source

public final LXNormalizedParameter source

The source parameter for this compound modulation mapping

target

public final LXCompoundModulation.Target target

The target parameter that receives the compound modulation

polarity

public final EnumParameter<LXParameter.Polarity> polarity

range

public final CompoundParameter range

Constructor Details

LXCompoundModulation

public LXCompoundModulation(LX lx,
 LXModulationEngine scope,
 JsonObject obj)
                     throws LXParameterModulation.ModulationException

Throws:

LXParameterModulation.ModulationException

LXCompoundModulation

public LXCompoundModulation(LXModulationEngine scope,
 LXNormalizedParameter source,
 LXCompoundModulation.Target target)
                     throws LXParameterModulation.ModulationException

Throws:

LXParameterModulation.ModulationException

Method Details

setPolarity

public LXCompoundModulation setPolarity(LXParameter.Polarity polarity)

getPolarity

public LXParameter.Polarity getPolarity()

getModulationAmount

public double getModulationAmount()

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

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 LXParameterModulation