Package heronarts.glx.ui

Class UI

java.lang.Object
heronarts.glx.ui.UI
Direct Known Subclasses:
LXStudio.UI
public class UI extends Object
Top-level container for all overlay UI elements.

  • Field Details

  • Constructor Details

  • Method Details

    • showError

      public void showError()

    • getHighlightModulationTarget

      public LXParameter getHighlightModulationTarget()

    • setHighlightModulationTarget

      public UI setHighlightModulationTarget(LXParameter highlightModulationTarget)

    • setHighlightParameterModulation

      public UI setHighlightParameterModulation(LXParameterModulation highlightParameterModulation)

    • setCoordinateSystem

      public UI setCoordinateSystem(UI.CoordinateSystem coordinateSystem)

    • redraw

      public void redraw()

    • get

      public static UI get()

    • focusPrev

      public void focusPrev(Event event)

    • focusNext

      public void focusNext(Event event)

    • setMouseoverHelpText

      public void setMouseoverHelpText(String helpText)

    • getMouseCursor

      public GLXWindow.MouseCursor getMouseCursor()

    • setTopLevelKeyEventHandler

      public UI setTopLevelKeyEventHandler(UIEventHandler eventHandler)
      Sets an object to handle top-level input events
      Parameters:
      eventHandler - Event handler
      Returns:
      this

    • mapModulationOff

      public UI mapModulationOff()

    • mapTriggerSource

      public UI mapTriggerSource()

    • mapTriggerSource

      public UI mapTriggerSource(UITriggerSource triggerSource)

    • mapTriggerSource

      public UI mapTriggerSource(UITriggerSource triggerSource, boolean preserveEngine)

    • mapTriggerSource

      public UI mapTriggerSource(UITriggerSource triggerSource, LXModulationEngine modulationEngine)

    • mapModulationSource

      public UI mapModulationSource()

    • mapModulationSource

      public UI mapModulationSource(UIModulationSource modulationSource)

    • mapModulationSource

      public UI mapModulationSource(UIModulationSource modulationSource, boolean preserveEngine)

    • mapModulationSource

      public UI mapModulationSource(UIModulationSource modulationSource, LXModulationEngine modulationEngine)

    • 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

    • 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

    • 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()

    • showContextDialogMessage

      public UI showContextDialogMessage(String message)

    • showContextOverlay

      public UI showContextOverlay(UI2dComponent contextOverlay)

    • setPositionRelative

      public UI setPositionRelative(UI2dComponent target, UIObject source, UI.Position... positions)
      Position the target element relative to the target
      Parameters:
      target - Target element (to be positioned)
      source - Source element (relative base)
      positions - Position specifications
      Returns:
      this

    • setPositionRelative

      public UI setPositionRelative(UI2dComponent target, UIObject source, boolean clamp, UI.Position... positions)
      Position the target element relative to the target
      Parameters:
      target - Target element (to be positioned)
      source - Source element (relative base)
      clamp - Whether to perform validity checks and clamp target placement in the UI window
      positions - Position specifications
      Returns:
      this

    • showContextOverlay

      public UI showContextOverlay(UI2dComponent contextOverlay, UIObject source, UI.Position... positions)

    • showContextOverlay

      public UI showContextOverlay(UI2dComponent contextOverlay, boolean clamp, UIObject source, UI.Position... positions)

    • resizeContextOverlay

      public UI resizeContextOverlay(UI2dComponent contextOverlay)

    • clearContextOverlay

      public UI clearContextOverlay(UI2dComponent contextOverlay)

    • hideDropMenu

      public UI hideDropMenu()

    • showDropMenu

      public UI showDropMenu(UIContextMenu dropMenu)

    • getContentScaleX

      public float getContentScaleX()

    • getContentScaleY

      public float getContentScaleY()

    • getWidth

      public float getWidth()

    • getHeight

      public float getHeight()

    • resize

      public void resize()

    • draw

      public final void draw()
      Draws the UI

    • beginDraw

      protected void beginDraw()

    • endDraw

      protected void endDraw()

    • onResize

      protected void onResize()

    • mouseEvent

      public void mouseEvent(MouseEvent mouseEvent)

    • keyEvent

      public void keyEvent(KeyEvent keyEvent)

    • gamepadEvent

      public void gamepadEvent(GamepadEvent gamepadEvent)

    • dispose

      public void dispose()