Package heronarts.lx.pattern.image

Class ImagePattern

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXDeviceComponent

heronarts.lx.pattern.LXPattern

heronarts.lx.pattern.image.ImagePattern

All Implemented Interfaces:

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

@LXCategory("Image")
@Description("Renders a 2D image")
public class ImagePattern
extends LXPattern

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ImagePattern.BackgroundMode
static class	ImagePattern.Image
static enum	ImagePattern.ImageMode

Nested classes/interfaces inherited from class heronarts.lx.pattern.LXPattern

LXPattern.Listener, LXPattern.Placeholder, LXPattern.Profiler

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

LXDeviceComponent.Midi

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

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.PluginRequired, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final ImagePattern.Image	image

Fields inherited from class heronarts.lx.pattern.LXPattern

compositeLevel, compositeMode, customCycleTimeSecs, effects, enabled, hasCustomCycleTime, launch, mutableEffects, PATH_EFFECT, profiler, recall, runMs

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

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.
protected void	run(double deltaMs)	Main pattern loop function.

Methods inherited from class heronarts.lx.pattern.LXPattern

activate, addEffect, addListener, applyEffects, clearInterval, deactivate, getChannel, getCompositeDampingLevel, getEffects, getIndex, getPath, handleOscMessage, hasInterval, initCompositeDamping, isAutoCycleEligible, isHiddenControl, isInInterval, isSnapshotControl, load, midiDispatch, moveEffect, onActive, onInactive, onLoop, onTransitionEnd, onTransitionStart, removeEffect, removeListener, save, setAutoCycleEligible, setChannel, setIndex, setInterval, toggleAutoCycleEligible, updateCompositeBlendOptions, updateCompositeDamping

Methods inherited from class heronarts.lx.LXDeviceComponent

addAutomationChild, addControlSurface, clearCustomRemoteControls, getControlSurfaces, getCrash, getCrashStackTrace, getCustomRemoteControls, getDeviceDescription, getDeviceVersion, getModelView, getModulationEngine, getModulationExpanded, getRemoteControls, loop, removeControlSurface, removeCustomRemoteControl, resetRemoteControls, 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, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, 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.effect.LXEffect.Container

addEffect, getEffect, getEffect, loadEffect

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

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

image

public final ImagePattern.Image image

Constructor Details

ImagePattern

public ImagePattern(LX lx)

Method Details

run

protected void run(double deltaMs)

Description copied from class: LXPattern

Main pattern loop function. Invoked in a render loop. Subclasses must implement this function.

Specified by:

run in class LXPattern

Parameters:

deltaMs - Number of milliseconds elapsed since last invocation

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 LXPattern