Package heronarts.lx.effect.color

Class ColorizeEffect

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.ColorizeEffect

All Implemented Interfaces:

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

@LXCategory("Color")
public class ColorizeEffect
extends LXEffect
implements GradientUtils.GradientFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ColorizeEffect.ColorMode
static enum	ColorizeEffect.SourceMode

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 EnumParameter<GradientUtils.BlendMode>	blendMode
final ColorParameter	color1
final ColorParameter	color2
final EnumParameter<ColorizeEffect.ColorMode>	colorMode
final CompoundParameter	gradientBrightness
final CompoundParameter	gradientHue
final CompoundParameter	gradientSaturation
final CompoundParameter	linkedBrightness
final CompoundParameter	linkedHue
final CompoundParameter	linkedSaturation
final DiscreteParameter	paletteIndex
final DiscreteParameter	paletteStops
final EnumParameter<ColorizeEffect.SourceMode>	source

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
ColorizeEffect(LX lx)

Method Summary

Modifier and Type	Method	Description
int	getGradientColor(float lerp)
LXDynamicColor	getSwatchColor()
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
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, 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

source

public final EnumParameter<ColorizeEffect.SourceMode> source

blendMode

public final EnumParameter<GradientUtils.BlendMode> blendMode

colorMode

public final EnumParameter<ColorizeEffect.ColorMode> colorMode

color1

public final ColorParameter color1

color2

public final ColorParameter color2

gradientHue

public final CompoundParameter gradientHue

gradientSaturation

public final CompoundParameter gradientSaturation

gradientBrightness

public final CompoundParameter gradientBrightness

linkedHue

public final CompoundParameter linkedHue

linkedSaturation

public final CompoundParameter linkedSaturation

linkedBrightness

public final CompoundParameter linkedBrightness

paletteIndex

public final DiscreteParameter paletteIndex

paletteStops

public final DiscreteParameter paletteStops

Constructor Details

ColorizeEffect

public ColorizeEffect(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

getSwatchColor

public LXDynamicColor getSwatchColor()

getGradientColor

public int getGradientColor(float lerp)

Specified by:

getGradientColor in interface GradientUtils.GradientFunction

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