Package heronarts.lx.effect

Class LinearMaskEffect

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

All Implemented Interfaces:

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

@LXCategory("Core")
@Name("Linear Mask")
@Description("Masks content by a brightness gradient with linear falloff")
public class LinearMaskEffect
extends LXEffect

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LinearMaskEffect.Axis
static interface	LinearMaskEffect.DistanceFunction
static enum	LinearMaskEffect.FadePosition
static enum	LinearMaskEffect.FadeSize
static enum	LinearMaskEffect.Mask
static interface	LinearMaskEffect.MaskFunction
static enum	LinearMaskEffect.Mode
static interface	LinearMaskEffect.PositionFunction

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

LXEffect.Container, 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.Author, LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.PluginRequired, LXComponent.Renamable, LXComponent.Tags

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final EnumParameter<LinearMaskEffect.Axis>	axis
final BooleanParameter	cue
final CompoundParameter	fade
final EnumParameter<LinearMaskEffect.FadePosition>	fadePosition
final EnumParameter<LinearMaskEffect.FadeSize>	fadeSize
final BooleanParameter	invert
final EnumParameter<LinearMaskEffect.Mask>	mask
final EnumParameter<LinearMaskEffect.Mode>	mode
final CompoundParameter	offset
final CompoundParameter	pitch
final CompoundParameter	roll
final BooleanParameter	rotate
final CompoundParameter	size
final CompoundParameter	yaw

Fields inherited from class heronarts.lx.effect.LXEffect

enabled, enabledDamped, enabledDampingAttack, enabledDampingRelease, hasDamping, locked, profiler

Fields inherited from class heronarts.lx.LXDeviceComponent

automationChildren, 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

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
LinearMaskEffect(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, getContainer, getIndex, getPath, getPattern, isBusEffect, isEnabled, isHiddenControl, isPatternEffect, load, onDisable, onEnable, onLoop, reload, setBus, setDamping, setDampingTime, setDampingTime, setIndex, setPattern, toggle

Methods inherited from class heronarts.lx.LXDeviceComponent

addAutomationChild, addControlSurface, clearCustomRemoteControls, getControlSurfaces, getCrash, getCrashStackTrace, getCustomRemoteControls, getDeviceDescription, getDeviceVersion, getModelView, getModulationEngine, getModulationExpanded, getRemoteControls, isClipAutomationControl, isSnapshotControl, loop, midiDispatch, removeControlSurface, removeCustomRemoteControl, resetRemoteControls, save, setCustomRemoteControls, setRemoteControls

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, applyEffects, blendColor, blendColor, clearColors, copyColors, copyColors, copyColors, copyColors, getBuffer, getColor, getColor, getColors, getLayers, lightestColor, 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, addInternalParameters, 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, 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, midiPanicReceived, noteOffReceived, noteOnReceived, pitchBendReceived, programChangeReceived, sysexReceived

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

Methods inherited from interface heronarts.lx.LXPresetComponent

getPresetClass, postProcessPreset

Field Details

axis

public final EnumParameter<LinearMaskEffect.Axis> axis

mode

public final EnumParameter<LinearMaskEffect.Mode> mode

mask

public final EnumParameter<LinearMaskEffect.Mask> mask

fadePosition

public final EnumParameter<LinearMaskEffect.FadePosition> fadePosition

fadeSize

public final EnumParameter<LinearMaskEffect.FadeSize> fadeSize

offset

public final CompoundParameter offset

size

public final CompoundParameter size

fade

public final CompoundParameter fade

invert

public final BooleanParameter invert

cue

public final BooleanParameter cue

rotate

public final BooleanParameter rotate

yaw

public final CompoundParameter yaw

pitch

public final CompoundParameter pitch

roll

public final CompoundParameter roll

Constructor Details

LinearMaskEffect

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