Package com.jme3.input

Class FlyByCamera

java.lang.Object
com.jme3.input.FlyByCamera
All Implemented Interfaces:
ActionListener, AnalogListener, InputListener
public class FlyByCamera extends Object implements AnalogListener, ActionListener
A first-person camera controller.

After creation, you (or FlyCamAppState) must register the controller using registerWithInput(com.jme3.input.InputManager).

Controls: - Move (or, in drag-to-rotate mode, drag) the mouse to rotate the camera - Mouse wheel for zooming in or out - WASD keys for moving forward/backward and strafing - QZ keys raise or lower the camera

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Camera
    cam
    camera controlled by this controller (not null)
    protected boolean
    canRotate
     
    protected boolean
    dragToRotate
    drag-to-rotate mode flag
    protected boolean
    enabled
    enable flag for controller (false→ignoring input)
    protected Vector3f
    initialUpVec
    normalized "up" direction (a unit vector)
    protected InputManager
    inputManager
     
    protected boolean
    invertY
     
    protected MotionAllowedListener
    motionAllowed
     
    protected float
    moveSpeed
    translation speed (in world units per second)
    protected float
    rotationSpeed
    rotation-rate multiplier (1=default)
    protected float
    zoomSpeed
    zoom-rate multiplier (1=default)

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlyByCamera(Camera cam)
    Creates a new FlyByCamera to control the specified camera.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getMoveSpeed()
    Retrieves the current translation speed of the camera.
    float
    getRotationSpeed()
    Retrieves the current rotation-rate multiplier.
    float
    getZoomSpeed()
    Retrieves the current zoom-rate multiplier.
    boolean
    isDragToRotate()
    Checks whether drag-to-rotate mode is currently enabled.
    boolean
    isEnabled()
    Checks whether this camera controller is currently enabled.
    protected void
    mapJoystick(Joystick joystick)
    Configures joystick input mappings for the camera controller.
    protected void
    moveCamera(float value, boolean sideways)
    Translates the camera left/right or forward/backward by the specified amount.
    void
    onAction(String name, boolean isPressed, float tpf)
    Callback to notify this controller of an action input event.
    void
    onAnalog(String name, float value, float tpf)
    Callback to notify this controller of an analog input event.
    void
    registerWithInput(InputManager inputManager)
    Registers this controller to receive input events from the specified InputManager.
    protected void
    riseCamera(float value)
    Translates the camera vertically (up or down) by the specified amount, considering the initialUpVec.
    protected void
    rotateCamera(float value, Vector3f axis)
    Rotates the camera by the specified amount around the given axis.
    void
    setDragToRotate(boolean dragToRotate)
    Enable or disable drag-to-rotate mode.
    void
    setEnabled(boolean enable)
    Enable or disable this controller.
    void
    setMotionAllowedListener(MotionAllowedListener listener)
     
    void
    setMoveSpeed(float moveSpeed)
    Sets the translation speed of the camera.
    void
    setRotationSpeed(float rotationSpeed)
    Sets the rotation-rate multiplier for mouse input.
    void
    setUpVector(Vector3f upVec)
    Sets the up vector that should be used for the camera.
    void
    setZoomSpeed(float zoomSpeed)
    Sets the zoom-rate multiplier for mouse wheel input.
    void
    unregisterInput()
    Unregisters this controller from its currently associated InputManager.
    protected void
    zoomCamera(float value)
    Zooms the camera by the specified amount.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • cam

      protected Camera cam
      camera controlled by this controller (not null)

    • initialUpVec

      protected Vector3f initialUpVec
      normalized "up" direction (a unit vector)

    • rotationSpeed

      protected float rotationSpeed
      rotation-rate multiplier (1=default)

    • moveSpeed

      protected float moveSpeed
      translation speed (in world units per second)

    • zoomSpeed

      protected float zoomSpeed
      zoom-rate multiplier (1=default)

    • motionAllowed

      protected MotionAllowedListener motionAllowed

    • enabled

      protected boolean enabled
      enable flag for controller (false→ignoring input)

    • dragToRotate

      protected boolean dragToRotate
      drag-to-rotate mode flag

    • canRotate

      protected boolean canRotate

    • invertY

      protected boolean invertY

    • inputManager

      protected InputManager inputManager

  • Constructor Details

    • FlyByCamera

      public FlyByCamera(Camera cam)
      Creates a new FlyByCamera to control the specified camera.
      Parameters:
      cam - camera to be controlled (not null)

  • Method Details

    • setUpVector

      public void setUpVector(Vector3f upVec)
      Sets the up vector that should be used for the camera.
      Parameters:
      upVec - the desired direction (not null, unaffected)

    • setMotionAllowedListener

      public void setMotionAllowedListener(MotionAllowedListener listener)

    • setMoveSpeed

      public void setMoveSpeed(float moveSpeed)
      Sets the translation speed of the camera.
      Parameters:
      moveSpeed - The new translation speed in world units per second. Must be non-negative.

    • getMoveSpeed

      public float getMoveSpeed()
      Retrieves the current translation speed of the camera.
      Returns:
      The current speed in world units per second.

    • setRotationSpeed

      public void setRotationSpeed(float rotationSpeed)
      Sets the rotation-rate multiplier for mouse input. A higher value means the camera rotates more for a given mouse movement.
      Parameters:
      rotationSpeed - The new rate multiplier (1.0 is default). Must be non-negative.

    • getRotationSpeed

      public float getRotationSpeed()
      Retrieves the current rotation-rate multiplier.
      Returns:
      The current rate multiplier.

    • setZoomSpeed

      public void setZoomSpeed(float zoomSpeed)
      Sets the zoom-rate multiplier for mouse wheel input. A higher value means the camera zooms more for a given mouse wheel scroll.
      Parameters:
      zoomSpeed - The new rate multiplier (1.0 is default). Must be non-negative.

    • getZoomSpeed

      public float getZoomSpeed()
      Retrieves the current zoom-rate multiplier.
      Returns:
      The current rate multiplier.

    • setEnabled

      public void setEnabled(boolean enable)
      Enable or disable this controller. When disabled, the controller ignored input.
      Parameters:
      enable - true to enable, false to disable

    • isEnabled

      public boolean isEnabled()
      Checks whether this camera controller is currently enabled.
      Returns:
      true if enabled, false otherwise.
      See Also:

    • isDragToRotate

      public boolean isDragToRotate()
      Checks whether drag-to-rotate mode is currently enabled.
      Returns:
      true if drag-to-rotate is enabled, false otherwise.
      See Also:

    • setDragToRotate

      public void setDragToRotate(boolean dragToRotate)
      Enable or disable drag-to-rotate mode. When drag-to-rotate mode is enabled, the user must hold the mouse button and drag over the screen to rotate the camera, and the cursor is visible until dragged. When drag-to-rotate mode is disabled, the cursor is invisible at all times and holding the mouse button is not needed to rotate the camera. This mode is disabled by default.
      Parameters:
      dragToRotate - true to enable, false to disable

    • registerWithInput

      public void registerWithInput(InputManager inputManager)
      Registers this controller to receive input events from the specified InputManager. This method sets up all the necessary input mappings for mouse, keyboard, and joysticks.
      Parameters:
      inputManager - The InputManager instance to register with (must not be null).

    • mapJoystick

      protected void mapJoystick(Joystick joystick)
      Configures joystick input mappings for the camera controller. This method attempts to map joystick axes and buttons to camera actions.
      Parameters:
      joystick - The Joystick to map (not null).

    • unregisterInput

      public void unregisterInput()
      Unregisters this controller from its currently associated InputManager.

    • rotateCamera

      protected void rotateCamera(float value, Vector3f axis)
      Rotates the camera by the specified amount around the given axis.
      Parameters:
      value - The amount of rotation.
      axis - The axis around which to rotate (a unit vector, unaffected).

    • zoomCamera

      protected void zoomCamera(float value)
      Zooms the camera by the specified amount. This method handles both perspective and parallel projections.
      Parameters:
      value - The amount to zoom. Positive values typically zoom in, negative out.

    • riseCamera

      protected void riseCamera(float value)
      Translates the camera vertically (up or down) by the specified amount, considering the initialUpVec.
      Parameters:
      value - The translation amount. Positive values move the camera up, negative down.

    • moveCamera

      protected void moveCamera(float value, boolean sideways)
      Translates the camera left/right or forward/backward by the specified amount.
      Parameters:
      value - The translation amount. Positive values move in the primary direction (right/forward), negative in the opposite.
      sideways - If true, the camera moves left/right (strafes). If false, the camera moves forward/backward.

    • onAnalog

      public void onAnalog(String name, float value, float tpf)
      Callback to notify this controller of an analog input event.
      Specified by:
      onAnalog in interface AnalogListener
      Parameters:
      name - name of the input event
      value - value of the axis (from 0 to 1)
      tpf - time per frame (in seconds)

    • onAction

      public void onAction(String name, boolean isPressed, float tpf)
      Callback to notify this controller of an action input event.
      Specified by:
      onAction in interface ActionListener
      Parameters:
      name - name of the input event
      isPressed - true if the action is "pressed", false otherwise
      tpf - time per frame (in seconds)