heronarts.p3lx

Class P3LX

java.lang.Object

heronarts.lx.LX

heronarts.p3lx.P3LX

Direct Known Subclasses:

LXStudio

public class P3LX
extends LX

Harness to run LX inside a Processing 3 sketch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	P3LX.Flags
class	P3LX.Profiler

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

LX.Error, LX.InitProfiler, LX.InstantiationException, LX.Listener, LX.Media, LX.Permissions, LX.ProjectListener

Field Summary

Fields

Modifier and Type	Field and Description
PApplet	applet A reference to the applet context.
P3LX.Flags	flags
P3LX.Profiler	profiler
UI	ui The UI container.
static String	VERSION

Fields inherited from class heronarts.lx.LX

clipboard, command, engine, errorChanged, failure, HALF_PI, HALF_PIf, initProfiler, LOG_WARNINGS, model, permissions, PIf, preferences, registry, scheduler, structure, TWO_PI, TWO_PIf

Constructor Summary

Constructors

Constructor and Description
P3LX(PApplet applet)
P3LX(PApplet applet, LXModel model)
P3LX(PApplet applet, P3LX.Flags flags)
P3LX(PApplet applet, P3LX.Flags flags, LXModel model)

Method Summary

Modifier and Type	Method and Description
protected UI	buildUI() Subclass may override.
void	dispose() Redundant, but making it obvious that Processing depends on this method being named dispose().
void	draw() Core function invoked by the processing engine on each iteration of the run cycle.
LX	enableKeyboardTempo() Enables the tempo to be controlled by the keyboard arrow keys.
static void	error(Exception x, String message)
static void	error(String message)
PGraphics	getGraphics()
LXEngine.Frame	getUIFrame() Returns the last rendered frame
<T extends LXComponent> T	instantiateComponent(Class<? extends T> cls, Class<T> type)
static void	log(String message)
void	setSystemClipboardString(String str)
protected void	showConfirmUnsavedProjectDialog(String message, Runnable confirm)
static String	version() Returns the version of the library.

Methods inherited from class heronarts.lx.LX

_error, _error, _log, _log, _log, addEffect, addEffects, addListener, addOutput, addProjectListener, bootstrapMediaPath, bootstrapMediaPath, confirmChangesSaved, disableAutoCycle, enableAutoCycle, error, error, error, fail, getComponent, getError, getMediaFile, getMediaFile, getMediaFile, getMediaFolder, getMediaFolder, getMediaPath, getMediaPath, getModel, getPatterns, getPermissions, getProject, getProjectComponent, goIndex, goNext, goPattern, goPrev, headless, hsa, hsb, instantiateBlend, instantiateBlend, instantiateComponent, instantiateEffect, instantiateEffect, instantiateFixture, instantiateFixture, instantiateModel, instantiateModulator, instantiateModulator, instantiatePattern, instantiatePattern, instantiateRegistry, isPaused, logInitProfiler, main, newProject, openProject, popError, pushError, pushError, pushError, registerExternal, removeEffect, removeListener, removeProjectListener, rgb, saveProject, saveProject, setLogFile, setModelImportFlag, setPatterns, setPaused, setProject, setScheduleLoadingFlag, setSpeed, togglePaused, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

applet

public final PApplet applet

A reference to the applet context.

ui

public final UI ui

The UI container.

flags

public final P3LX.Flags flags

profiler

public final P3LX.Profiler profiler

Constructor Detail

P3LX

public P3LX(PApplet applet)

P3LX

public P3LX(PApplet applet,
            LXModel model)

P3LX

public P3LX(PApplet applet,
            P3LX.Flags flags)

P3LX

public P3LX(PApplet applet,
            P3LX.Flags flags,
            LXModel model)

Method Detail

version

public static String version()

Returns the version of the library.

Returns:

String

showConfirmUnsavedProjectDialog

protected void showConfirmUnsavedProjectDialog(String message,
                                               Runnable confirm)

Overrides:

showConfirmUnsavedProjectDialog in class LX

buildUI

protected UI buildUI()

Subclass may override.

Returns:

UI

dispose

public void dispose()

Redundant, but making it obvious that Processing depends on this method being named dispose(). This protects us from a rename in LX where someone doesn't realize the Processing naming dependency.

Overrides:

dispose in class LX

enableKeyboardTempo

public LX enableKeyboardTempo()

Enables the tempo to be controlled by the keyboard arrow keys. Left and right arrows change the tempo by .1 BPM, and the space-bar taps the tempo.

Returns:

this

getGraphics

public final PGraphics getGraphics()

getUIFrame

public final LXEngine.Frame getUIFrame()

Returns the last rendered frame

Returns:

The frame to be shown on the UI

draw

public void draw()

Core function invoked by the processing engine on each iteration of the run cycle.

instantiateComponent

public <T extends LXComponent> T instantiateComponent(Class<? extends T> cls,
                                                      Class<T> type)

Overrides:

instantiateComponent in class LX

setSystemClipboardString

public void setSystemClipboardString(String str)

Overrides:

setSystemClipboardString in class LX

log

public static void log(String message)

error

public static void error(Exception x,
                         String message)

error

public static void error(String message)