Class Camera

All Implemented Interfaces:
ICamera, IUpdateable, Tweenable
Direct Known Subclasses:
FreeFlightCamera, LocationLockCamera
public class Camera extends Object implements ICamera, Tweenable
Represents the camera used for rendering the game world. The camera handles focus, zoom, shake effects, and viewport calculations.

  • Constructor Details

    • Camera

      public Camera()
      Instantiates a new Camera instance.

  • Method Details

    • getFocus

      public Point2D getFocus()
      Description copied from interface: ICamera
      Gets the map location that is focused by this camera.
      Specified by:
      getFocus in interface ICamera
      Returns:
      the focus's location in map coordinates

    • getMapLocation

      public Point2D getMapLocation(Point2D viewPortLocation)
      Description copied from interface: ICamera
      Converts a point in screen coordinates into a map location.
      Specified by:
      getMapLocation in interface ICamera
      Parameters:
      viewPortLocation - the point in screen coordinates
      Returns:
      the map location

    • getPixelOffsetX

      public double getPixelOffsetX()
      Description copied from interface: ICamera
      Gets the x coordinate of the viewport's origin.
      Specified by:
      getPixelOffsetX in interface ICamera
      Returns:
      the offset, in screen coordinates

    • getPixelOffsetY

      public double getPixelOffsetY()
      Description copied from interface: ICamera
      Gets the y coordinate of the viewport's origin.
      Specified by:
      getPixelOffsetY in interface ICamera
      Returns:
      the offset, in screen coordinates

    • getViewport

      public Rectangle2D getViewport()
      Description copied from interface: ICamera
      Gets the camera's viewport region, in screen coordinates.
      Specified by:
      getViewport in interface ICamera
      Returns:
      the viewport region, in screen coordinates

    • getViewportDimensionCenter

      public Point2D getViewportDimensionCenter(IEntity entity)
      Description copied from interface: ICamera
      Gets the center of the entity, in screen coordinates.
      Specified by:
      getViewportDimensionCenter in interface ICamera
      Parameters:
      entity - The entity to retrieve the dimension center for.
      Returns:
      the center, in screen coordinates

    • getViewportLocation

      public Point2D getViewportLocation(double x, double y)
      Description copied from interface: ICamera
      Converts a location in map coordinates into screen coordinates.
      Specified by:
      getViewportLocation in interface ICamera
      Parameters:
      x - The x-coordinate of the viewport location.
      y - The y-coordinate of the viewport location.
      Returns:
      the screen location

    • getZoom

      public float getZoom()
      Description copied from interface: ICamera
      The zoom factor of this camera.
      Specified by:
      getZoom in interface ICamera
      Returns:
      the scale factor

    • onZoom

      public void onZoom(ICamera.ZoomChangedListener listener)
      Description copied from interface: ICamera
      Adds the specified zoom changed listener to receive events when the zoom of this camera changed.
      Specified by:
      onZoom in interface ICamera
      Parameters:
      listener - The listener to add.

    • removeZoomListener

      public void removeZoomListener(ICamera.ZoomChangedListener listener)
      Description copied from interface: ICamera
      Removes the specified zoom changed listener.
      Specified by:
      removeZoomListener in interface ICamera
      Parameters:
      listener - The listener to remove.

    • onFocus

      public void onFocus(ICamera.FocusChangedListener listener)
      Description copied from interface: ICamera
      Adds the specified focus changed listener to receive events when the focus of this camera changed.
      Specified by:
      onFocus in interface ICamera
      Parameters:
      listener - The listener to add.

    • removeFocusListener

      public void removeFocusListener(ICamera.FocusChangedListener listener)
      Description copied from interface: ICamera
      Removes the specified focus changed listener.
      Specified by:
      removeFocusListener in interface ICamera
      Parameters:
      listener - The listener to remove.

    • setFocus

      public void setFocus(Point2D focus)
      Description copied from interface: ICamera
      Focuses the camera on a given point.
      Specified by:
      setFocus in interface ICamera
      Parameters:
      focus - the point, in map coordinates

    • setFocus

      public void setFocus(double x, double y)
      Description copied from interface: ICamera
      Focuses the camera on a given point.
      Specified by:
      setFocus in interface ICamera
      Parameters:
      x - the x coordinate of the point, in map coordinates
      y - the y coordinate of the point, in map coordinates

    • setZoom

      public void setZoom(float targetZoom, int delay)
      Description copied from interface: ICamera
      Changes the camera's zoom over the specified duration (in frames) to the target zoom.
      Specified by:
      setZoom in interface ICamera
      Parameters:
      targetZoom - the new zoom scale
      delay - the number of frames between this call and when the zoom completes

    • shake

      public void shake(double intensity, int delay, int shakeDuration)
      Description copied from interface: ICamera
      Shakes the camera for the specified duration. The way the camera shakes is implementation defined.
      Specified by:
      shake in interface ICamera
      Parameters:
      intensity - The intensity of the screen shake effect.
      delay - The delay in milliseconds between randomized offset updates.
      shakeDuration - The total duration of the effect in milliseconds.

    • update

      public void update()
      Description copied from interface: IUpdateable
      This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.
      Specified by:
      update in interface IUpdateable
      See Also:

    • updateFocus

      public void updateFocus()
      Description copied from interface: ICamera
      Currently an update function for the shake effect.
      Specified by:
      updateFocus in interface ICamera

    • isClampToMap

      public boolean isClampToMap()
      Description copied from interface: ICamera
      Returns whether this camera will clamp the viewport to the bounds of the map.
      Specified by:
      isClampToMap in interface ICamera
      Returns:
      True if the camera viewport is currently clamped to the map boundaries; otherwise false.

    • setClampToMap

      public void setClampToMap(boolean clampToMap)
      Description copied from interface: ICamera
      Set the camera to clamp the viewport to the bounds of the map.
      Specified by:
      setClampToMap in interface ICamera
      Parameters:
      clampToMap - A flag indicating whether the camera viewport should be clamped to the map boundaries.

    • setClampAlign

      public void setClampAlign(Align align, Valign valign)
      Description copied from interface: ICamera
      Sets the alignment for clamping the camera to the map boundaries.
      Specified by:
      setClampAlign in interface ICamera
      Parameters:
      align - The horizontal alignment (e.g., left, center, or right).
      valign - The vertical alignment (e.g., top, middle, or bottom).

    • getClampAlign

      public Align getClampAlign()
      Description copied from interface: ICamera
      Gets the current horizontal alignment used for clamping the camera to the map boundaries.
      Specified by:
      getClampAlign in interface ICamera
      Returns:
      The horizontal alignment.

    • getClampValign

      public Valign getClampValign()
      Description copied from interface: ICamera
      Gets the current vertical alignment used for clamping the camera to the map boundaries.
      Specified by:
      getClampValign in interface ICamera
      Returns:
      The vertical alignment.

    • pan

      public void pan(Point2D focus, int duration)
      Description copied from interface: ICamera
      Pans the camera over the specified duration (in frames) to the target location, after accounting for modifications such as clamping to the map. Event listeners attached to this camera are notified when the pan completes.
      Specified by:
      pan in interface ICamera
      Parameters:
      focus - the new focus for the camera once the panning is complete
      duration - the number of frames between this call and when the pan completes

    • pan

      public void pan(double x, double y, int duration)
      Description copied from interface: ICamera
      Pans the camera over the specified duration (in frames) to the target location, after accounting for modifications such as clamping to the map. Event listeners attached to this camera are notified when the pan completes.
      Specified by:
      pan in interface ICamera
      Parameters:
      x - the new X coordinate for the camera once the panning is complete
      y - the new Y coordinate for the camera once the panning is complete
      duration - the number of frames between this call and when the pan completes

    • clampToMap

      protected Point2D clampToMap(Point2D focus)

      Clamps a given focus point to ensure it remains within the visible bounds of the current map.

      This method ensures that the camera's focus point does not move outside the boundaries of the map. It centers the camera around the focus point, but only to the extent that the map dimensions allow. If the viewport is larger than the map in either dimension, the Camera's Align and VAlign is applied to determine how to handle the excess space.

      Parameters:
      focus - the desired focus point in map coordinates.
      Returns:
      a new Point2D representing the clamped focus point, adjusted to remain within the bounds of the map view.

    • panTime

      protected int panTime()
      Gets the remaining pan time for the camera.
      Returns:
      The remaining time (in ticks) for the camera to complete its pan operation.

    • getViewportWidth

      protected double getViewportWidth()

      Calculates the width of the camera's viewport in world units.

      The viewport width is determined by dividing the game window's resolution width by the current render scale.

      Returns:
      The width of the viewport in world units.

    • getViewportHeight

      protected double getViewportHeight()

      Calculates the height of the camera's viewport in world units.

      The viewport height is determined by dividing the game window's resolution height by the current render scale.

      Returns:
      The height of the viewport in world units.

    • getTweenValues

      public float[] getTweenValues(TweenType tweenType)
      Provides current tween values for camera-related TweenTypes so that the camera can be animated by the TweenEngine. Supports TweenType.ZOOM, TweenType.LOCATION_X, TweenType.LOCATION_Y and TweenType.LOCATION_XY for zooming and panning.
      Specified by:
      getTweenValues in interface Tweenable
      Parameters:
      tweenType - The tween type of this interpolation, determining which values are modified.
      Returns:
      The array of current tween values.

    • setTweenValues

      public void setTweenValues(TweenType tweenType, float[] newValues)
      Applies interpolated tween values to the camera. See getTweenValues(TweenType) for the list of supported tween types.
      Specified by:
      setTweenValues in interface Tweenable
      Parameters:
      tweenType - The tween type of this interpolation, determining which values are modified.
      newValues - The new values determined by the tween equation.