com.simsilica.lemur

Class GuiGlobals

java.lang.Object

com.simsilica.lemur.GuiGlobals

public class GuiGlobals
extends java.lang.Object

A utility class that sets up some default global behavior for the default GUI elements and provides some common access to things like the AssetManager.

When initialized, GuiGlobals will keep a reference to the AssetManager for use in creating materials, loading fonts, and so on. It will also:

• Setup the KeyInterceptState for allowing edit fields to intercept key events ahead of the regular input processing.
• Initialize InputMapper to provide advanced controller input processing.
• Setup the MouseAppState to provide default mouse listener and picking support for registered pick roots.
• Setup the FocusManagerState that keeps track of the currently focused component and makes sure transition methods are properly called.
• Setup the default styles.
• Sets up the layer based geometry comparators for the default app viewport.

For applications that wish to customize the behavior of GuiGlobals, it is possible to set a custom subclass instead of initializing the default implemenation. Examples of reasons do do this might include using custom materials instead of the default JME materials or otherwise customizing the initialization setup.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GuiGlobals(com.jme3.app.Application app)

Method Summary

Modifier and Type	Method and Description
void	addKeyListener(KeyListener l)
GuiMaterial	createMaterial(boolean lit)
GuiMaterial	createMaterial(com.jme3.math.ColorRGBA color, boolean lit)
GuiMaterial	createMaterial(com.jme3.texture.Texture texture, boolean lit)
void	fixFont(com.jme3.font.BitmapFont font) Goes through all of the font page materials and sets alpha test and alpha fall-off.
AnimationState	getAnimationState()
protected com.jme3.asset.AssetManager	getAssetManager()
com.jme3.renderer.ViewPort	getCollisionViewPort(com.jme3.scene.Spatial s) Deprecated.
com.jme3.scene.Spatial	getCurrentFocus()
FocusManagerState	getFocusManagerState()
FocusNavigationState	getFocusNavigationState()
protected java.lang.String	getIconBase()
InputMapper	getInputMapper()
static GuiGlobals	getInstance()
PopupState	getPopupState()
com.jme3.math.Vector3f	getScreenCoordinates(com.jme3.scene.Spatial relativeTo, com.jme3.math.Vector3f pos) Deprecated.
Styles	getStyles()
boolean	hasRequestedCursorEnabled(java.lang.Object owner) Returns true if the specified owner has an active cursor enabled request pending.
static void	initialize(com.jme3.app.Application app)
boolean	isCursorEventsEnabled()
protected boolean	isHeadless(com.jme3.app.Application app)
boolean	isMouseEventsEnabled() Deprecated. Use isCursorEventsEnabled() instead.
void	lightFont(com.jme3.font.BitmapFont font)
com.jme3.texture.Texture	loadDefaultIcon(java.lang.String name)
com.jme3.font.BitmapFont	loadFont(java.lang.String path)
com.jme3.texture.Texture	loadTexture(java.lang.String path, boolean repeat, boolean generateMips)
protected void	logBuildInfo()
boolean	releaseCursorEnabled(java.lang.Object owner) Releases a previous cursor request for the specified sowner.
void	releaseFocus(com.jme3.scene.Spatial s)
void	removeKeyListener(KeyListener l)
void	requestCursorEnabled(java.lang.Object owner) Indicates that the specified owner requires the cursor to be enabled.
void	requestFocus(com.jme3.scene.Spatial s)
void	setCursorEventsEnabled(boolean f)
void	setCursorEventsEnabled(boolean f, boolean force) The same as setCursorEventsEnabled(f) except that this will force the cursor enabled state even if there are pending requests otherwise.
protected void	setDefaultStyles()
static void	setInstance(GuiGlobals globals)
void	setMouseEventsEnabled(boolean f) Deprecated. Use setCursorEventsEnabled() instead.
void	setupGuiComparators(com.jme3.renderer.ViewPort view)
com.jme3.math.ColorRGBA	srgbaColor(com.jme3.math.ColorRGBA srgbColor) Creates a color from the specified RGBA values as if they were in SRGB space, depending on whether gamma correction is enabled or disabled.
com.jme3.math.ColorRGBA	srgbaColor(float r, float g, float b, float a) Creates a color from the specified RGBA values as if they were in SRGB space, depending on whether gamma correction is enabled or disabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiGlobals

protected GuiGlobals(com.jme3.app.Application app)

Method Detail

initialize

public static void initialize(com.jme3.app.Application app)

setInstance

public static void setInstance(GuiGlobals globals)

getInstance

public static GuiGlobals getInstance()

isHeadless

protected boolean isHeadless(com.jme3.app.Application app)

getAssetManager

protected com.jme3.asset.AssetManager getAssetManager()

getIconBase

protected java.lang.String getIconBase()

logBuildInfo

protected void logBuildInfo()

setupGuiComparators

public void setupGuiComparators(com.jme3.renderer.ViewPort view)

setDefaultStyles

protected void setDefaultStyles()

getStyles

public Styles getStyles()

getInputMapper

public InputMapper getInputMapper()

getAnimationState

public AnimationState getAnimationState()

getPopupState

public PopupState getPopupState()

getFocusManagerState

public FocusManagerState getFocusManagerState()

getFocusNavigationState

public FocusNavigationState getFocusNavigationState()

fixFont

public void fixFont(com.jme3.font.BitmapFont font)

Goes through all of the font page materials and sets alpha test and alpha fall-off.

lightFont

public void lightFont(com.jme3.font.BitmapFont font)

loadFont

public com.jme3.font.BitmapFont loadFont(java.lang.String path)

createMaterial

public GuiMaterial createMaterial(boolean lit)

createMaterial

public GuiMaterial createMaterial(com.jme3.math.ColorRGBA color,
                                  boolean lit)

createMaterial

public GuiMaterial createMaterial(com.jme3.texture.Texture texture,
                                  boolean lit)

loadDefaultIcon

public com.jme3.texture.Texture loadDefaultIcon(java.lang.String name)

loadTexture

public com.jme3.texture.Texture loadTexture(java.lang.String path,
                                            boolean repeat,
                                            boolean generateMips)

srgbaColor

public com.jme3.math.ColorRGBA srgbaColor(float r,
                                          float g,
                                          float b,
                                          float a)

Creates a color from the specified RGBA values as if they were in SRGB space, depending on whether gamma correction is enabled or disabled. If there is no gamma correction then the RGBA values are interpretted literally. If gamma correction is enabled then the values are converted to linear space before returning.

srgbaColor

public com.jme3.math.ColorRGBA srgbaColor(com.jme3.math.ColorRGBA srgbColor)

Creates a color from the specified RGBA values as if they were in SRGB space, depending on whether gamma correction is enabled or disabled. If there is no gamma correction then the RGBA values are interpretted literally. If gamma correction is enabled then the values are converted to linear space before returning.

requestFocus

public void requestFocus(com.jme3.scene.Spatial s)

releaseFocus

public void releaseFocus(com.jme3.scene.Spatial s)

getCurrentFocus

public com.jme3.scene.Spatial getCurrentFocus()

addKeyListener

public void addKeyListener(KeyListener l)

removeKeyListener

public void removeKeyListener(KeyListener l)

getCollisionViewPort

@Deprecated
public com.jme3.renderer.ViewPort getCollisionViewPort(com.jme3.scene.Spatial s)

Deprecated.

requestCursorEnabled

public void requestCursorEnabled(java.lang.Object owner)

Indicates that the specified owner requires the cursor to be enabled. This is a way of letting multiple separate UI elements manage their need for the cursor. If one particular object indicates that it no longer has a need for the cursor then it can be disabled if no other owners require it. This makes it easier to automatically manage the enabled/disabled state of the picking behavior in the face of complicated UIs.

releaseCursorEnabled

public boolean releaseCursorEnabled(java.lang.Object owner)

Releases a previous cursor request for the specified sowner. Returns true if the cursor is still enabled after this call.

hasRequestedCursorEnabled

public boolean hasRequestedCursorEnabled(java.lang.Object owner)

Returns true if the specified owner has an active cursor enabled request pending.

setMouseEventsEnabled

@Deprecated
public void setMouseEventsEnabled(boolean f)

Deprecated. Use setCursorEventsEnabled() instead.

setCursorEventsEnabled

public void setCursorEventsEnabled(boolean f)

setCursorEventsEnabled

public void setCursorEventsEnabled(boolean f,
                                   boolean force)

The same as setCursorEventsEnabled(f) except that this will force the cursor enabled state even if there are pending requests otherwise. This can be a way to force the enabled/disabled state in the case where an application has not converted to the new request/release approach and/or has a specific need where counting requests will not work.

isMouseEventsEnabled

@Deprecated
public boolean isMouseEventsEnabled()

Deprecated. Use isCursorEventsEnabled() instead.

isCursorEventsEnabled

public boolean isCursorEventsEnabled()

getScreenCoordinates

@Deprecated
public com.jme3.math.Vector3f getScreenCoordinates(com.jme3.scene.Spatial relativeTo,
                                                                com.jme3.math.Vector3f pos)

Deprecated.