Package heronarts.lx.effect.color

Class ColorMaskEffect

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXDeviceComponent

heronarts.lx.effect.LXEffect

heronarts.lx.effect.color.ColorMaskEffect

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXPresetComponent, LXSerializable, LXMidiListener, LXModulationContainer, LXOscComponent, LXParameterListener

@LXCategory("Color")
@LXComponentName("Color Mask")
public class ColorMaskEffect
extends LXEffect

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ColorMaskEffect.Mode

Nested classes/interfaces inherited from class heronarts.lx.effect.LXEffect

LXEffect.Placeholder, LXEffect.Profiler

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

LXDeviceComponent.Midi

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

LXComponent.Hidden, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final LinkedColorParameter	color
final CompoundParameter	depth
final EnumParameter<ColorMaskEffect.Mode>	mode

Fields inherited from class heronarts.lx.effect.LXEffect

enabled, enabledDamped, enabledDampingAttack, enabledDampingRelease, hasDamping, profiler

Fields inherited from class heronarts.lx.LXDeviceComponent

controlsExpanded, controlsExpandedAux, controlsExpandedCue, controlSurfaceSemaphore, crashed, DEVICE_CATEGORY_NAME_SORT, DEVICE_VERSION_UNSPECIFIED, KEY_DEVICE_VERSION, midiFilter, modulation, modulationExpanded, remoteControlsChanged, view, viewPriority

Fields inherited from class heronarts.lx.LXLayeredComponent

colors, layers, palette

Fields inherited from class heronarts.lx.LXModelComponent

model

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators

Fields inherited from class heronarts.lx.LXComponent

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

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
ColorMaskEffect(LX lx)

Method Summary

Modifier and Type	Method	Description
protected void	run(double deltaMs, double enabledAmount)	Implementation of the effect.

Methods inherited from class heronarts.lx.effect.LXEffect

disable, dispose, enable, getBus, getIndex, getModelView, getPath, getPattern, isBusEffect, isEnabled, isHiddenControl, isPatternEffect, onDisable, onEnable, onLoop, setBus, setDamping, setDampingTime, setDampingTime, setIndex, setPattern, toggle

Methods inherited from class heronarts.lx.LXDeviceComponent

addControlSurface, clearCustomRemoteControls, getControlSurfaces, getCrash, getCrashStackTrace, getCustomRemoteControls, getDeviceVersion, getModulationEngine, getRemoteControls, isSnapshotControl, load, loop, midiDispatch, removeControlSurface, removeCustomRemoteControl, resetRemoteControls, save, setCustomRemoteControls, setRemoteControls

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, blendColor, blendColor, clearColors, getBuffer, getColor, getColor, getColors, getLayers, removeLayer, setBuffer, setBuffer, setColor, setColor, setColor, setColors, subtractColor

Methods inherited from class heronarts.lx.LXModelComponent

getModel, onModelChanged, setModel

Methods inherited from class heronarts.lx.LXModulatorComponent

addModulator, addModulator, addModulator, addModulator, addModulator, constructProfiler, getModulator, getModulators, moveModulator, removeModulator, startModulator

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, 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.midi.LXMidiListener

aftertouchReceived, controlChangeReceived, noteOffReceived, noteOnReceived, pitchBendReceived, programChangeReceived

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Methods inherited from interface heronarts.lx.LXPresetComponent

getPresetClass, postProcessPreset

Field Details

mode

public final EnumParameter<ColorMaskEffect.Mode> mode

color

public final LinkedColorParameter color

depth

public final CompoundParameter depth

Constructor Details

ColorMaskEffect

public ColorMaskEffect(LX lx)

Method Details

run

protected void run(double deltaMs,
 double enabledAmount)

Description copied from class: LXEffect

Implementation of the effect. Subclasses need to override this to implement their functionality.

Specified by:

run in class LXEffect

Parameters:

deltaMs - Number of milliseconds elapsed since last invocation

enabledAmount - The amount of the effect to apply, scaled from 0-1