de.gurkenlabs.litiengine.graphics.ImageRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of litiengine Show documentation
The FOSS 2D Java game engine.
The newest version!
package de.gurkenlabs.litiengine.graphics;

import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.geom.AffineTransform;
import java.awt.geom.Point2D;

/**
 * This class provides static methods to render an {@code Image} to a given {@code Graphics2D} object at specified screen coordinates. It includes
 * methods for rendering images with transformations such as rotation, scaling, and custom affine transformations. This class is final and cannot be
 * instantiated.
 *
 * @see Image
 * @see Graphics2D
 */
public final class ImageRenderer {

  private ImageRenderer() {
    throw new UnsupportedOperationException();
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified coordinates.
   *
   * @param g     The graphics object to draw on.
   * @param image The image to be drawn.
   * @param x     The x-coordinate of the image.
   * @param y     The y-coordinate of the image.
   */
  public static void render(final Graphics2D g, final Image image, final double x, final double y) {
    if (image == null) {
      return;
    }

    final AffineTransform t = AffineTransform.getTranslateInstance(x, y);
    g.drawImage(image, t, null);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified location.
   *
   * @param g              The graphics object to draw on.
   * @param image          The image to be drawn.
   * @param renderLocation The location where the image will be drawn.
   */
  public static void render(final Graphics2D g, final Image image, final Point2D renderLocation) {
    render(g, image, renderLocation.getX(), renderLocation.getY());
  }

  /***
   * Note that rotating an image with 90/180/270 degree is way more performant. than rotating with in other degrees.
   *
   * @param g
   *          The graphics object to draw on.
   * @param image
   *          The image to be drawn
   * @param x
   *          The x-coordinate of the image.
   * @param y
   *          The y-coordinate of the image
   * @param angle
   *          The angle by which the image will be rotated.
   */
  public static void renderRotated(
    final Graphics2D g, final Image image, final double x, final double y, final double angle) {
    if (image == null) {
      return;
    }

    if (angle == 0 || angle % 360 == 0) {
      render(g, image, x, y);
      return;
    }

    final AffineTransform t = new AffineTransform();

    t.translate(x, y);
    t.rotate(Math.toRadians(angle), image.getWidth(null) * 0.5, image.getHeight(null) * 0.5);

    g.drawImage(image, t, null);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified location with rotation.
   *
   * @param g              The graphics object to draw on.
   * @param image          The image to be drawn.
   * @param renderLocation The location where the image will be drawn.
   * @param angle          The angle by which the image will be rotated.
   */
  public static void renderRotated(
    final Graphics2D g, final Image image, final Point2D renderLocation, final double angle) {
    renderRotated(g, image, renderLocation.getX(), renderLocation.getY(), angle);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified coordinates with scaling.
   *
   * @param g     The graphics object to draw on.
   * @param image The image to be drawn.
   * @param x     The x-coordinate of the image.
   * @param y     The y-coordinate of the image.
   * @param scale The scale factor for both width and height.
   */
  public static void renderScaled(
    final Graphics2D g, final Image image, final double x, final double y, final double scale) {
    renderScaled(g, image, x, y, scale, scale);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified location with scaling.
   *
   * @param g        The graphics object to draw on.
   * @param image    The image to be drawn.
   * @param location The location where the image will be drawn.
   * @param scale    The scale factor for both width and height.
   */
  public static void renderScaled(
    final Graphics2D g, final Image image, final Point2D location, final double scale) {
    renderScaled(g, image, location.getX(), location.getY(), scale, scale);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified location with scaling.
   *
   * @param g        The graphics object to draw on.
   * @param image    The image to be drawn.
   * @param location The location where the image will be drawn.
   * @param scaleX   The scale factor for the width.
   * @param scaleY   The scale factor for the height.
   */
  public static void renderScaled(
    final Graphics2D g,
    final Image image,
    final Point2D location,
    final double scaleX,
    final double scaleY) {
    renderScaled(g, image, location.getX(), location.getY(), scaleX, scaleY);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified coordinates with scaling.
   *
   * @param g      The graphics object to draw on.
   * @param image  The image to be drawn.
   * @param x      The x-coordinate of the image.
   * @param y      The y-coordinate of the image.
   * @param scaleX The scale factor for the width.
   * @param scaleY The scale factor for the height.
   */
  public static void renderScaled(
    final Graphics2D g,
    final Image image,
    final double x,
    final double y,
    final double scaleX,
    final double scaleY) {
    if (image == null) {
      return;
    }

    if (scaleX == 1 && scaleY == 1) {
      render(g, image, x, y);
      return;
    }

    final AffineTransform t = new AffineTransform();

    t.translate(x, y);
    t.scale(scaleX, scaleY);

    g.drawImage(image, t, null);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified location with a custom affine transformation.
   *
   * @param g              The graphics object to draw on.
   * @param image          The image to be drawn.
   * @param renderLocation The location where the image will be drawn.
   * @param transform      The affine transformation to be applied to the image.
   */
  public static void renderTransformed(
    final Graphics2D g,
    final Image image,
    final Point2D renderLocation,
    AffineTransform transform) {
    renderTransformed(g, image, renderLocation.getX(), renderLocation.getY(), transform);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object at the specified coordinates with a custom affine transformation.
   *
   * @param g         The graphics object to draw on.
   * @param image     The image to be drawn.
   * @param x         The x-coordinate of the image.
   * @param y         The y-coordinate of the image.
   * @param transform The affine transformation to be applied to the image.
   */
  public static void renderTransformed(
    final Graphics2D g, final Image image, double x, double y, AffineTransform transform) {
    if (transform == null) {
      render(g, image, x, y);
      return;
    }

    AffineTransform t = new AffineTransform();
    t.translate(x, y);
    t.concatenate(transform);

    g.drawImage(image, t, null);
  }

  /**
   * Renders the specified {@code Image} to the given {@code Graphics2D} object with a custom affine transformation.
   *
   * @param g         The graphics object to draw on.
   * @param image     The image to be drawn.
   * @param transform The affine transformation to be applied to the image.
   */
  public static void renderTransformed(
    final Graphics2D g, final Image image, AffineTransform transform) {
    if (transform == null) {
      return;
    }

    g.drawImage(image, transform, null);
  }
}