heronarts.p3lx.ui

Class UI

java.lang.Object

heronarts.p3lx.ui.UI

All Implemented Interfaces:

LXEngine.Dispatch

Direct Known Subclasses:

LXStudio.UI

public class UI
extends Object
implements LXEngine.Dispatch

Top-level container for all overlay UI elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UI.CoordinateSystem
class	UI.Profiler

Field Summary

Fields

Modifier and Type	Field and Description
PApplet	applet
static int	BLACK Black color
StringParameter	contextualHelpText
protected UI.CoordinateSystem	coordinateSystem
P3LX	lx
UI.Profiler	profiler
UITheme	theme UI look and feel
static int	WHITE White color

Constructor Summary

Constructors

Constructor and Description
UI(P3LX lx)
UI(PApplet applet) Creates a new UI instance

Method Summary

Modifier and Type	Method and Description
UI	addLayer(UI2dContext layer) Add a 2d context to this UI
UI	addLayer(UI2dContext layer, int index) Add a 2d context to this UI at the given index
UI	addLayer(UI3dContext layer) Add a 3d context to this UI
UI	addLayer(UI3dContext layer, int index) Add a 3d context to this UI, at the given index
UI	addLoopTask(LXLoopTask loopTask) Add a task to be performed on every loop of the UI engine.
protected void	beginDraw()
UI	bringToTop(UI2dContext layer) Brings a layer to the top of the UI stack
void	dispatch()
void	draw() Draws the UI
protected void	endDraw()
void	focusNext(Event event)
void	focusPrev(Event event)
static UI	get()
int	getHeight() Get height of the UI
int	getWidth() Get width of the UI
UI	hideContextOverlay()
void	keyEvent(KeyEvent keyEvent)
PFont	loadFont(String font) Load a font file
UI	mapModulationSource(LXModulationEngine modulationEngine, UIModulationSource modulationSource)
UI	mapModulationSource(UIModulationSource modulationSource)
UI	mapTriggerSource(UITriggerSource triggerSource)
void	mouseEvent(MouseEvent mouseEvent)
void	onLoad(File file)
protected void	onResize()
void	onSaveAs(File file)
void	pre()
void	reflow()
UI	removeLayer(UI2dContext layer) Remove a 2d context from this UI
UI	removeLayer(UI3dContext layer)
UI	removeLoopTask(LXLoopTask loopTask) Remove a task from the UI engine
void	resize(int width, int height)
UI	setBackground(boolean hasBackground)
UI	setBackgroundColor(int backgroundColor)
UI	setCoordinateSystem(UI.CoordinateSystem coordinateSystem)
UI	setHighlightParameterModulation(LXParameterModulation highlightParameterModulation)
void	setMouseoverHelpText(String helpText)
UI	setResizable(boolean resizable) Sets whether the UI should be resizable.
UI	setTopLevelKeyEventHandler(UIEventHandler eventHandler) Sets an object to handle top-level input events
void	showConfirmDialog(String message, Runnable confirm)
UI	showContextOverlay(UI2dComponent contextOverlay)
void	showError()

Methods inherited from class java.lang.Object

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

Field Detail

profiler

public final UI.Profiler profiler

lx

public final P3LX lx

applet

public final PApplet applet

contextualHelpText

public final StringParameter contextualHelpText

coordinateSystem

protected UI.CoordinateSystem coordinateSystem

theme

public final UITheme theme

UI look and feel

WHITE

public static final int WHITE

White color

See Also:

Constant Field Values

BLACK

public static final int BLACK

Black color

See Also:

Constant Field Values

Constructor Detail

UI

public UI(P3LX lx)

UI

public UI(PApplet applet)

Creates a new UI instance

Parameters:

applet - The PApplet

Method Detail

showError

public void showError()

setHighlightParameterModulation

public UI setHighlightParameterModulation(LXParameterModulation highlightParameterModulation)

setCoordinateSystem

public UI setCoordinateSystem(UI.CoordinateSystem coordinateSystem)

reflow

public void reflow()

get

public static UI get()

setBackground

public UI setBackground(boolean hasBackground)

setBackgroundColor

public UI setBackgroundColor(int backgroundColor)

focusPrev

public void focusPrev(Event event)

focusNext

public void focusNext(Event event)

setMouseoverHelpText

public void setMouseoverHelpText(String helpText)

setTopLevelKeyEventHandler

public UI setTopLevelKeyEventHandler(UIEventHandler eventHandler)

Sets an object to handle top-level input events

Parameters:

eventHandler - Event handler

Returns:

this

mapTriggerSource

public UI mapTriggerSource(UITriggerSource triggerSource)

mapModulationSource

public UI mapModulationSource(UIModulationSource modulationSource)

mapModulationSource

public UI mapModulationSource(LXModulationEngine modulationEngine,
                              UIModulationSource modulationSource)

setResizable

public UI setResizable(boolean resizable)

Sets whether the UI should be resizable.

Parameters:

resizable - Whether UI is resizable

Returns:

this

getWidth

public int getWidth()

Get width of the UI

Returns:

width

getHeight

public int getHeight()

Get height of the UI

Returns:

height

addLoopTask

public UI addLoopTask(LXLoopTask loopTask)

Add a task to be performed on every loop of the UI engine.

Parameters:

loopTask - Task to perform on every UI loop

Returns:

this

removeLoopTask

public UI removeLoopTask(LXLoopTask loopTask)

Remove a task from the UI engine

Parameters:

loopTask - Task to stop performing on every UI loop

Returns:

this

addLayer

public UI addLayer(UI2dContext layer)

Add a 2d context to this UI

Parameters:

layer - UI layer

Returns:

this

addLayer

public UI addLayer(UI2dContext layer,
                   int index)

Add a 2d context to this UI at the given index

Parameters:

layer - UI layer

index - Index

Returns:

this

removeLayer

public UI removeLayer(UI2dContext layer)

Remove a 2d context from this UI

Parameters:

layer - UI layer

Returns:

this UI

addLayer

public UI addLayer(UI3dContext layer)

Add a 3d context to this UI

Parameters:

layer - 3d context

Returns:

this UI

addLayer

public UI addLayer(UI3dContext layer,
                   int index)

Add a 3d context to this UI, at the given index

Parameters:

layer - 3d context

index - Index in the UI stack

Returns:

this UI

removeLayer

public UI removeLayer(UI3dContext layer)

bringToTop

public UI bringToTop(UI2dContext layer)

Brings a layer to the top of the UI stack

Parameters:

layer - UI layer

Returns:

this UI

hideContextOverlay

public UI hideContextOverlay()

showContextOverlay

public UI showContextOverlay(UI2dComponent contextOverlay)

showConfirmDialog

public void showConfirmDialog(String message,
                              Runnable confirm)

loadFont

public PFont loadFont(String font)

Load a font file

Parameters:

font - Font name

Returns:

PFont object

resize

public void resize(int width,
                   int height)

pre

public final void pre()

draw

public final void draw()

Draws the UI

beginDraw

protected void beginDraw()

endDraw

protected void endDraw()

onResize

protected void onResize()

dispatch

public void dispatch()

Specified by:

dispatch in interface LXEngine.Dispatch

mouseEvent

public void mouseEvent(MouseEvent mouseEvent)

keyEvent

public void keyEvent(KeyEvent keyEvent)

onSaveAs

public final void onSaveAs(File file)

onLoad

public final void onLoad(File file)