Package com.jme3.util

Class VRGuiManager

java.lang.Object
com.jme3.util.VRGuiManager
public class VRGuiManager extends Object
A class dedicated to the management and the display of a Graphical User Interface (GUI) within a VR environment.

  • Field Details

    • wantsReposition

      protected boolean wantsReposition

  • Constructor Details

    • VRGuiManager

      public VRGuiManager(VREnvironment environment)
      Create a new GUI manager attached to the given app state.
      Parameters:
      environment - the VR environment to which this manager is attached to.

  • Method Details

    • isWantsReposition

      public boolean isWantsReposition()

    • setWantsReposition

      public void setWantsReposition(boolean wantsReposition)

    • setPositioningElasticity

      public void setPositioningElasticity(float elastic)
      Makes auto GUI positioning happen not immediately, but like an elastic connected to the headset. Setting to 0 disables (default) Higher settings make it track the headset quicker.
      Parameters:
      elastic - amount of elasticity

    • getPositioningElasticity

      public float getPositioningElasticity()

    • getPositioningMode

      public VRGUIPositioningMode getPositioningMode()
      Get the GUI positioning mode.
      Returns:
      the GUI positioning mode.
      See Also:

    • setPositioningMode

      public void setPositioningMode(VRGUIPositioningMode mode)
      Set the GUI positioning mode.
      Parameters:
      mode - the GUI positioning mode.
      See Also:

    • getCanvasSize

      public Vector2f getCanvasSize()
      Get the GUI canvas size. This method return the size in pixels of the GUI available area within the VR view.
      Returns:
      the GUI canvas size. This method return the size in pixels of the GUI available area within the VR view.

    • getCanvasToWindowRatio

      public Vector2f getCanvasToWindowRatio()
      Get the ratio between the GUI canvas size and the application main windows (if available) or the screen size.
      Returns:
      the ratio between the GUI canvas size and the application main windows (if available).
      See Also:

    • positionGui

      public void positionGui()
      Inform this manager that it has to position the GUI.

    • updateGuiQuadGeometricState

      public void updateGuiQuadGeometricState()
      Update the GUI geometric state. This method should be called after GUI modification.

    • positionGuiNow

      public void positionGuiNow(float tpf)
      Position the GUI without delay.
      Parameters:
      tpf - the time per frame.

    • getGuiDistance

      public float getGuiDistance()
      Get the GUI distance from the observer.
      Returns:
      the GUI distance from the observer.
      See Also:

    • setGuiDistance

      public void setGuiDistance(float newGuiDistance)
      Set the GUI distance from the observer.
      Parameters:
      newGuiDistance - the GUI distance from the observer.
      See Also:

    • getGUIScale

      public float getGUIScale()
      Get the GUI scale.
      Returns:
      the GUI scale.
      See Also:

    • setGuiScale

      public void setGuiScale(float scale)
      Set the GUI scale.
      Parameters:
      scale - the GUI scale.
      See Also:

    • adjustGuiDistance

      public void adjustGuiDistance(float adjustAmount)
      Adjust the GUI distance from the observer. This method increment / decrement the GUI distance by the given value.
      Parameters:
      adjustAmount - the increment (if positive) / decrement (if negative) value of the GUI distance.

    • setupGui

      public void setupGui(Camera leftCam, Camera rightCam, ViewPort left, ViewPort right)
      Set up the GUI.
      Parameters:
      leftCam - the left-eye camera.
      rightCam - the right-eye camera.
      left - the left-eye viewport.
      right - the right-eye viewport.

    • isCurverSurface

      public boolean isCurverSurface()
      Get if the GUI has to use curved surface.
      Returns:
      true if the GUI has to use curved surface and false otherwise.
      See Also:

    • setCurvedSurface

      public void setCurvedSurface(boolean set)
      Set if the GUI has to use curved surface.
      Parameters:
      set - true if the GUI has to use curved surface and false otherwise.
      See Also:

    • isGuiOverdraw

      public boolean isGuiOverdraw()
      Get if the GUI has to be displayed even if it is behind objects.
      Returns:
      true if the GUI has to use curved surface and false otherwise.
      See Also:

    • setGuiOverdraw

      public void setGuiOverdraw(boolean set)
      Set if the GUI has to be displayed even if it is behind objects.
      Parameters:
      set - true if the GUI has to use curved surface and false otherwise.
      See Also: