Package heronarts.glx

Class GLX

java.lang.Object

heronarts.lx.LX

heronarts.glx.GLX

Direct Known Subclasses:

LXStudio

public class GLX
extends LX

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GLX.FileDialogCallback
static class	GLX.Flags	Flags that control the behavior of the application
final class	GLX.Programs
final class	GLX.VertexBuffers

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

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

Field Summary

Fields

Modifier and Type	Field	Description
final BGFXEngine	bgfx	BGFX rendering engine
final GLX.Flags	flags
final GLX.Programs	program	Publicly accessible, globally reusable shader programs.
final UI	ui	The UI stack
final LXEngine.Frame	uiFrame
final GLX.VertexBuffers	vertexBuffer	Publicly accessible, globally reusable vertex buffers
final VGraphics	vg	The Vector Graphics implementation
final GLXWindow	window	The window that runs this application

Fields inherited from class heronarts.lx.LX

clipboard, command, engine, errorChanged, failure, HALF_PI, HALF_PIf, initProfiler, KEY_TIMESTAMP, KEY_VERSION, LOG_DEBUG, LOG_WARNINGS, model, permissions, PIf, preferences, registry, scheduler, statusMessage, structure, TWO_PI, TWO_PIf, VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GLX(GLXWindow window)
protected	GLX(GLXWindow window, GLX.Flags flags)
protected	GLX(GLXWindow window, GLX.Flags flags, LXModel model)

Method Summary

Modifier and Type	Method	Description
protected static void	_error(String prefix, String message)
void	assertBgfxThread(String error)
void	assertBgfxThreadAllocation(BGFXEngine.Resource resource)
void	assertBgfxThreadDispose(BGFXEngine.Resource resource)
void	assertBgfxThreadUpdate(BGFXEngine.Resource resource)
boolean	bgfxThreadDispose(BGFXEngine.Resource resource)	Returns true if we are on the BGFX thread and can immediately dispose of this resource.
protected UI	buildUI()	Subclasses may override to create a custom structured UI
void	dispose()	Shut down resources of the LX instance.
static void	error(Exception x, String message)
static void	error(String message)
void	importContentJar(File file, boolean overwrite)
protected void	importContentJar(File file, File destination)
static void	log(String message)
static void	openDesktop(String url)
void	reloadContent()
void	run()
void	setSystemClipboardString(String str)
void	showAddScheduleEntryDialog()
void	showConfirmDialog(String message, Runnable confirm)
protected void	showConfirmUnsavedModelDialog(File file, Runnable confirm)
protected void	showConfirmUnsavedProjectDialog(String message, Runnable confirm)
void	showOpenFileDialog(String dialogTitle, String fileType, String[] extensions, String defaultPath, GLX.FileDialogCallback success)	Show an open file dialog
void	showOpenProjectDialog()
void	showOpenScheduleDialog()
void	showSaveFileDialog(String dialogTitle, String fileType, String[] extensions, String defaultPath, GLX.FileDialogCallback success)	Show a save file dialog
void	showSaveProjectDialog()
void	showSaveScheduleDialog()

Methods inherited from class heronarts.lx.LX

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

Methods inherited from class java.lang.Object

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

Field Details

flags

public final GLX.Flags flags

window

public final GLXWindow window

The window that runs this application

bgfx

public final BGFXEngine bgfx

BGFX rendering engine

vg

public final VGraphics vg

The Vector Graphics implementation

program

public final GLX.Programs program

Publicly accessible, globally reusable shader programs.

vertexBuffer

public final GLX.VertexBuffers vertexBuffer

Publicly accessible, globally reusable vertex buffers

ui

public final UI ui

The UI stack

uiFrame

public final LXEngine.Frame uiFrame

Constructor Details

GLX

protected GLX(GLXWindow window)
       throws IOException

Throws:

IOException

GLX

protected GLX(GLXWindow window,
 GLX.Flags flags)
       throws IOException

Throws:

IOException

GLX

protected GLX(GLXWindow window,
 GLX.Flags flags,
 LXModel model)
       throws IOException

Throws:

IOException

Method Details

assertBgfxThreadAllocation

public void assertBgfxThreadAllocation(BGFXEngine.Resource resource)

assertBgfxThreadUpdate

public void assertBgfxThreadUpdate(BGFXEngine.Resource resource)

assertBgfxThreadDispose

public void assertBgfxThreadDispose(BGFXEngine.Resource resource)

assertBgfxThread

public void assertBgfxThread(String error)

bgfxThreadDispose

public boolean bgfxThreadDispose(BGFXEngine.Resource resource)

Returns true if we are on the BGFX thread and can immediately dispose of this resource. Otherwise it is scheduled to run later on the BGFX thread at which point this call will succeed.

Parameters:

resource - Resource

Returns:

true if the dispose code should run now

run

public void run()

dispose

public void dispose()

Description copied from class: LX

Shut down resources of the LX instance.

Overrides:

dispose in class LX

buildUI

protected UI buildUI()
              throws IOException

Subclasses may override to create a custom structured UI

Returns:

The instantiated UI object

Throws:

IOException - if required UI assets could not be loaded

importContentJar

public void importContentJar(File file,
 boolean overwrite)

importContentJar

protected void importContentJar(File file,
 File destination)

reloadContent

public void reloadContent()

showSaveProjectDialog

public void showSaveProjectDialog()

showOpenProjectDialog

public void showOpenProjectDialog()

showSaveScheduleDialog

public void showSaveScheduleDialog()

showAddScheduleEntryDialog

public void showAddScheduleEntryDialog()

showOpenScheduleDialog

public void showOpenScheduleDialog()

showSaveFileDialog

public void showSaveFileDialog(String dialogTitle,
 String fileType,
 String[] extensions,
 String defaultPath,
 GLX.FileDialogCallback success)

Show a save file dialog

Parameters:

dialogTitle - Dialog title

fileType - File type description

extensions - Valid file extensions

defaultPath - Default file path

success - Callback on successful invocation

showOpenFileDialog

public void showOpenFileDialog(String dialogTitle,
 String fileType,
 String[] extensions,
 String defaultPath,
 GLX.FileDialogCallback success)

Show an open file dialog

Parameters:

dialogTitle - Dialog title

fileType - File type description

extensions - Valid file extensions

defaultPath - Default file path

success - Callback on successful invocation

showConfirmUnsavedProjectDialog

protected void showConfirmUnsavedProjectDialog(String message,
 Runnable confirm)

Overrides:

showConfirmUnsavedProjectDialog in class LX

showConfirmUnsavedModelDialog

protected void showConfirmUnsavedModelDialog(File file,
 Runnable confirm)

Overrides:

showConfirmUnsavedModelDialog in class LX

showConfirmDialog

public void showConfirmDialog(String message,
 Runnable confirm)

Overrides:

showConfirmDialog in class LX

setSystemClipboardString

public void setSystemClipboardString(String str)

Overrides:

setSystemClipboardString in class LX

openDesktop

public static void openDesktop(String url)

log

public static void log(String message)

error

public static void error(Exception x,
 String message)

error

public static void error(String message)

_error

protected static void _error(String prefix,
 String message)