Package heronarts.lx.color

Class LXDynamicColor

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.color.LXDynamicColor

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXDynamicColor
extends LXModulatorComponent
implements LXOscComponent

A dynamic color is a color that has a few different settings that allows it to either be fixed or to change its value over time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LXDynamicColor.Mode

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

LXModulatorComponent.Profiler

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<GradientUtils.BlendMode>	blendMode
final ColorParameter	color
final EnumParameter<LXDynamicColor.Mode>	mode
final BoundedParameter	period
final ColorParameter	primary
final ColorParameter	secondary

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators, profiler

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

Modifier	Constructor	Description
	LXDynamicColor(LXSwatch swatch)
protected	LXDynamicColor(LXSwatch swatch, int initialColor)

Method Summary

Modifier and Type	Method	Description
double	getBasis()
float	getBrightness()
int	getColor()	Gets the current value of this dynamic color
double	getHue()	Gets the hue of the current dynamic color.
float	getHuef()	Gets the hue of the current dynamic color.
int	getIndex()
String	getPath()	Accessor for the path of this object.
float	getSaturation()	Gets the saturation of the current dynamic color.
LXSwatch	getSwatch()

Methods inherited from class heronarts.lx.LXModulatorComponent

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

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

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

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

Field Details

mode

public final EnumParameter<LXDynamicColor.Mode> mode

blendMode

public final EnumParameter<GradientUtils.BlendMode> blendMode

period

public final BoundedParameter period

primary

public final ColorParameter primary

secondary

public final ColorParameter secondary

color

public final ColorParameter color

Constructor Details

LXDynamicColor

public LXDynamicColor(LXSwatch swatch)

LXDynamicColor

protected LXDynamicColor(LXSwatch swatch,
 int initialColor)

Method Details

getSwatch

public LXSwatch getSwatch()

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

getIndex

public int getIndex()

getBasis

public double getBasis()

getHue

public double getHue()

Gets the hue of the current dynamic color. This will return a valid value even if brightness is all the way down and the color is black.

Returns:

Hue

getHuef

public float getHuef()

Gets the hue of the current dynamic color. This will return a valid value even if brightness is all the way down and the color is black.

Returns:

Hue

getSaturation

public float getSaturation()

Gets the saturation of the current dynamic color. This will return a valid value even if brightness is all the way down and the color is black.

getBrightness

public float getBrightness()

getColor

public int getColor()

Gets the current value of this dynamic color

Returns:

Color, which may be blending or oscillating different options