PopupState (lemur 1.15.0 API)

java.lang.Object
- com.jme3.app.state.BaseAppState
- - com.simsilica.lemur.event.PopupState

All Implemented Interfaces:

com.jme3.app.state.AppState
```
public class PopupState
extends com.jme3.app.state.BaseAppState
```
Provides modal-style popup support where a single UI element can essentially 'take over' the screen. The single pop-up will be the only thing that can receive events. Outside mouse clicks will either close the panel or be ignored depending on how the popup was configured when opened.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PopupState.ClickMode
Controls the behavior for clicks outside the specified popup.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PopupState.ClickMode` Controls the behavior for clicks outside the specified popup.

Constructor Summary

Constructors
Constructor and Description

PopupState()

PopupState(com.jme3.scene.Node guiNode)

Constructors
Constructor and Description
`PopupState()`
`PopupState(com.jme3.scene.Node guiNode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`centerInGui(com.jme3.scene.Spatial s)` Positions the specified spatial so that it is in the center of the GUI.
`boolean`	`clampToGui(com.jme3.scene.Spatial s)` Moves the specified GUI element so that it is the most on the screen that it can be based on the current GUI size.
`protected void`	`cleanup(com.jme3.app.Application app)`
`protected void`	`close(com.simsilica.lemur.event.PopupState.PopupEntry entry)`
`void`	`closePopup(com.jme3.scene.Spatial popup)` Closes a previously opened popup.
`protected com.jme3.scene.Geometry`	`createBlocker(float z, com.jme3.math.ColorRGBA backgroundColor)`
`protected GuiMaterial`	`createBlockerMaterial(com.jme3.math.ColorRGBA color)`
`protected com.simsilica.lemur.event.PopupState.PopupEntry`	`getEntry(com.jme3.scene.Spatial popup)`
`com.jme3.scene.Node`	`getGuiNode()` Returns the GUI node that will be used to display the option panel.
`com.jme3.math.Vector2f`	`getGuiSize()` Returns the size of the screen based on the app's main camera size and the current scale of the guiNode.
`protected float`	`getMaxGuiZ()` Calcules that maximum Z value given the current contents of the GUI node.
`protected float`	`getMaxZ(com.jme3.bounding.BoundingVolume bv)`
`protected float`	`getMinZ(com.jme3.bounding.BoundingVolume bv)`
`boolean`	`hasActivePopups()`
`protected void`	`initialize(com.jme3.app.Application app)`
`boolean`	`isPopup(com.jme3.scene.Spatial s)` Returns true if the specified Spatial is still an active popup.
`protected void`	`onDisable()`
`protected void`	`onEnable()`
`void`	`setGuiNode(com.jme3.scene.Node guiNode)` Sets the GUI node that will be used to display the option panel.
`void`	`showModalPopup(com.jme3.scene.Spatial popup)` Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
`void`	`showModalPopup(com.jme3.scene.Spatial popup, com.jme3.math.ColorRGBA backgroundColor)` Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
`void`	`showModalPopup(com.jme3.scene.Spatial popup, Command<? super PopupState> closeCommand)` Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
`void`	`showModalPopup(com.jme3.scene.Spatial popup, Command<? super PopupState> closeCommand, com.jme3.math.ColorRGBA backgroundColor)` Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
`void`	`showPopup(com.jme3.scene.Spatial popup)` Shows the specified spatial on the GUI node with a background blocker geometry that will automatically close the spatial when clicked.
`void`	`showPopup(com.jme3.scene.Spatial popup, Command<? super PopupState> closeCommand)` Shows the specified spatial on the GUI node with a background blocker geometry that will automatically close the spatial when clicked.
`void`	`showPopup(com.jme3.scene.Spatial popup, PopupState.ClickMode clickMode, Command<? super PopupState> closeCommand, com.jme3.math.ColorRGBA backgroundColor)` Shows the specified popup on the GUI node with the specified click mode determining how background mouse events will be handled.
`void`	`update(float tpf)`

Methods inherited from class com.jme3.app.state.BaseAppState
cleanup, getApplication, getState, getStateManager, initialize, isEnabled, isInitialized, postRender, render, setEnabled, stateAttached, stateDetached

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PopupState
```
public PopupState()
```
  - PopupState
```
public PopupState(com.jme3.scene.Node guiNode)
```
- Method Detail
  - hasActivePopups
```
public boolean hasActivePopups()
```
  - showPopup
```
public void showPopup(com.jme3.scene.Spatial popup)
```
    Shows the specified spatial on the GUI node with a background blocker geometry that will automatically close the spatial when clicked.
  - showPopup
```
public void showPopup(com.jme3.scene.Spatial popup,
                      Command<? super PopupState> closeCommand)
```
    Shows the specified spatial on the GUI node with a background blocker geometry that will automatically close the spatial when clicked.
  - showModalPopup
```
public void showModalPopup(com.jme3.scene.Spatial popup)
```
    Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
  - showModalPopup
```
public void showModalPopup(com.jme3.scene.Spatial popup,
                           Command<? super PopupState> closeCommand)
```
    Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
  - showModalPopup
```
public void showModalPopup(com.jme3.scene.Spatial popup,
                           com.jme3.math.ColorRGBA backgroundColor)
```
    Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
  - showModalPopup
```
public void showModalPopup(com.jme3.scene.Spatial popup,
                           Command<? super PopupState> closeCommand,
                           com.jme3.math.ColorRGBA backgroundColor)
```
    Shows the specified spatial on the GUI node with a background blocker geometry that will consume all mouse events until the popup has been closed.
  - showPopup
```
public void showPopup(com.jme3.scene.Spatial popup,
                      PopupState.ClickMode clickMode,
                      Command<? super PopupState> closeCommand,
                      com.jme3.math.ColorRGBA backgroundColor)
```
    Shows the specified popup on the GUI node with the specified click mode determining how background mouse events will be handled. An optional closeCommand will be called when the popup is closed. An optional background color will be used for the background 'blocker' geometry.
  - isPopup
```
public boolean isPopup(com.jme3.scene.Spatial s)
```
    Returns true if the specified Spatial is still an active popup.
  - closePopup
```
public void closePopup(com.jme3.scene.Spatial popup)
```
    Closes a previously opened popup. Throws IllegalArgumentException if the specified popup is not open.
  - close
```
protected void close(com.simsilica.lemur.event.PopupState.PopupEntry entry)
```
  - getEntry
```
protected com.simsilica.lemur.event.PopupState.PopupEntry getEntry(com.jme3.scene.Spatial popup)
```
  - getMaxGuiZ
```
protected float getMaxGuiZ()
```
    Calcules that maximum Z value given the current contents of the GUI node.
  - getMaxZ
```
protected float getMaxZ(com.jme3.bounding.BoundingVolume bv)
```
  - getMinZ
```
protected float getMinZ(com.jme3.bounding.BoundingVolume bv)
```
  - createBlockerMaterial
```
protected GuiMaterial createBlockerMaterial(com.jme3.math.ColorRGBA color)
```
  - createBlocker
```
protected com.jme3.scene.Geometry createBlocker(float z,
                                                com.jme3.math.ColorRGBA backgroundColor)
```
  - getGuiSize
```
public com.jme3.math.Vector2f getGuiSize()
```
    Returns the size of the screen based on the app's main camera size and the current scale of the guiNode.
  - centerInGui
```
public void centerInGui(com.jme3.scene.Spatial s)
```
    Positions the specified spatial so that it is in the center of the GUI.
  - clampToGui
```
public boolean clampToGui(com.jme3.scene.Spatial s)
```
    Moves the specified GUI element so that it is the most on the screen that it can be based on the current GUI size. Returns true if the spatial was actually moved.
  - setGuiNode
```
public void setGuiNode(com.jme3.scene.Node guiNode)
```
    Sets the GUI node that will be used to display the option panel. By default, this is SimpleApplication.getGuiNode().
  - getGuiNode
```
public com.jme3.scene.Node getGuiNode()
```
    Returns the GUI node that will be used to display the option panel. By default, this is SimpleApplication.getGuiNode().
  - initialize
```
protected void initialize(com.jme3.app.Application app)
```
    Specified by:
    
    initialize in class com.jme3.app.state.BaseAppState
  - cleanup
```
protected void cleanup(com.jme3.app.Application app)
```
    Specified by:
    
    cleanup in class com.jme3.app.state.BaseAppState
  - onEnable
```
protected void onEnable()
```
    Specified by:
    
    onEnable in class com.jme3.app.state.BaseAppState
  - update
```
public void update(float tpf)
```
    Specified by:
    
    update in interface com.jme3.app.state.AppState
    
    Overrides:
    
    update in class com.jme3.app.state.BaseAppState
  - onDisable
```
protected void onDisable()
```
    Specified by:
    
    onDisable in class com.jme3.app.state.BaseAppState

Class PopupState

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.jme3.app.state.BaseAppState

Methods inherited from class java.lang.Object

Constructor Detail

PopupState

PopupState

Method Detail

hasActivePopups

showPopup

showPopup

showModalPopup

showModalPopup

showModalPopup

showModalPopup

showPopup

isPopup

closePopup

close

getEntry

getMaxGuiZ

getMaxZ

getMinZ

createBlockerMaterial

createBlocker

getGuiSize

centerInGui

clampToGui

setGuiNode

getGuiNode

initialize

cleanup

onEnable

update

onDisable