Package gaiasky.gui

Class AbstractGui

java.lang.Object
gaiasky.gui.AbstractGui
All Implemented Interfaces:
com.badlogic.gdx.utils.Disposable, IObserver, IGui
Direct Known Subclasses:
CrashGui, DebugGui, FullGui, GamepadGui, LoadingGui, RenderGui, SpacecraftGui, StereoGui, WelcomeGui, WelcomeGuiVR
public abstract class AbstractGui extends Object implements IObserver, IGui

  • Field Details

    • graphics

      protected com.badlogic.gdx.Graphics graphics
      Graphics instance.

    • stage

      protected com.badlogic.gdx.scenes.scene2d.Stage stage
      The user interface stage.

    • skin

      protected com.badlogic.gdx.scenes.scene2d.ui.Skin skin
      The skin to use.

    • interfaces

      protected com.badlogic.gdx.utils.Array<IGuiInterface> interfaces
      The GUI interfaces, if any.

    • name

      protected String name
      The name of this GUI.

    • vr

      protected boolean vr
      Whether we're in VR mode.

    • unitsPerPixel

      protected float unitsPerPixel
      Units per pixel, 1/uiScale. This only works with a screen viewport.

    • lock

      protected final Object lock
      Lock for sync.

    • backBufferWidth

      protected int backBufferWidth

    • backBufferHeight

      protected int backBufferHeight

  • Constructor Details

    • AbstractGui

      public AbstractGui(com.badlogic.gdx.Graphics graphics, Float unitsPerPixel)

  • Method Details

    • update

      public void update(double dt)
      Description copied from interface: IGui
      Updates the GUI
      Specified by:
      update in interface IGui
      Parameters:
      dt - Time in seconds since the last frame

    • render

      public void render(int rw, int rh)
      Description copied from interface: IGui
      Renders this GUI
      Specified by:
      render in interface IGui
      Parameters:
      rw - The render width
      rh - The render height

    • getGuiStage

      public com.badlogic.gdx.scenes.scene2d.Stage getGuiStage()
      Description copied from interface: IGui
      Returns the stage
      Specified by:
      getGuiStage in interface IGui
      Returns:
      The stage

    • getName

      public String getName()

    • dispose

      public void dispose()
      Specified by:
      dispose in interface com.badlogic.gdx.utils.Disposable

    • resize

      public void resize(int width, int height)
      Description copied from interface: IGui
      Resizes this GUI to the given values at the end of the current loop
      Specified by:
      resize in interface IGui
      Parameters:
      width - The new width
      height - The new height

    • resizeImmediate

      public void resizeImmediate(int width, int height)
      Description copied from interface: IGui
      Resizes without waiting for the current loop to finish
      Specified by:
      resizeImmediate in interface IGui
      Parameters:
      width - The new width
      height - The new height

    • rebuildGui

      protected abstract void rebuildGui()
      Adds the already created GUI objects to the stage.

    • cancelTouchFocus

      public boolean cancelTouchFocus()
      Description copied from interface: IGui
      Removes the focus from this GUI and returns true if the focus was in the GUI, false otherwise.
      Specified by:
      cancelTouchFocus in interface IGui
      Returns:
      true if the focus was in the GUI, false otherwise.

    • findActor

      public com.badlogic.gdx.scenes.scene2d.Actor findActor(String name)
      Description copied from interface: IGui
      Returns the first actor found with the specified name. Note this recursively compares the name of every actor in the GUI.
      Specified by:
      findActor in interface IGui
      Returns:
      The actor if it exists, null otherwise.

    • setVisibilityToggles

      public void setVisibilityToggles(ComponentTypes.ComponentType[] entities, ComponentTypes visible)
      Description copied from interface: IGui
      Sets the visibility state of the component entities
      Specified by:
      setVisibilityToggles in interface IGui
      Parameters:
      entities - The entities
      visible - The states

    • notify

      public void notify(Event event, Object source, Object... data)
      Description copied from interface: IObserver
      Event notification call.
      Specified by:
      notify in interface IObserver
      Parameters:
      event - The event type.
      source - The source object, if any.
      data - The data associated with this event.

    • setVR

      public void setVR(boolean vr)
      Description copied from interface: IGui
      Whether this GUI is to be used in VR mode
      Specified by:
      setVR in interface IGui
      Parameters:
      vr - Vr mode is active

    • isVR

      public boolean isVR()
      Description copied from interface: IGui
      Returns whether this GUI is a VR gui.
      Specified by:
      isVR in interface IGui
      Returns:
      Is this a VR gui?

    • mustDraw

      public boolean mustDraw()
      Description copied from interface: IGui
      Returns whether this GUI must be drawn or not
      Specified by:
      mustDraw in interface IGui
      Returns:
      Whether this is visible

    • updateUnitsPerPixel

      public boolean updateUnitsPerPixel(float upp)
      Description copied from interface: IGui
      Updates the units-per-pixel value of this GUI. The units-per-pixel is the same as 1/UI_SCALE.
      Specified by:
      updateUnitsPerPixel in interface IGui

    • setBackBufferSize

      public void setBackBufferSize(int width, int height)
      Description copied from interface: IGui
      Sets the back buffer size.
      Specified by:
      setBackBufferSize in interface IGui

    • getBackBufferWidth

      public int getBackBufferWidth()

    • getBackBufferHeight

      public int getBackBufferHeight()