Package de.pirckheimer_gymnasium.engine_pi

Class Camera

java.lang.Object
de.pirckheimer_gymnasium.engine_pi.Camera
public final class Camera extends Object
Die Kamera steuert, welcher Ausschnitt der Spielfläche angezeigt wird.

Sie kann ein Objekt fokussieren und ihm so folgen. Hierbei besteht auch die Möglichkeit, diesen Fokus in Grenzen zu halten. Und zwar durch die Fokus-Bounds. Diese 4 Grenzwerte können individuell verstellt und aktiviert werden. auch kann man den von der Kamera darzustellenden Bereich durch eine einzige Methode definieren, in dem man den Bereich als Bounds beschreibt. 


 Bounds bounds = new Bounds(0, 0, 1500, 1000);
 camera.setBounds(bounds);

Hierdurch wird der gesamte Fokus auf den Bereich zwischen den Punkten (0|0) und (1500|1000) eingestellt.

!!Achtung!!

Bei den Fokus-Einstellungen sollte immer ein Bereich gewählt werden, der die Größe des Anzeigefensters (oder Vollbildes) bei weitem übersteigt.
Allgemein wirken diese Bounds auch ohne aktivierten Fokus, jedoch ist dies meist weniger sinnvoll.

Author:
Michael Andonie

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final double
    DEFAULT_METER
    Der Standardwert für die Anzahl an Pixel eines Meters.
    static final double
    DEFAULT_ZOOM_FACTOR
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Camera()
    Konstruktor erstellt eine neue Kamera mit Fokus auf (0, 0).

  • Method Summary

    Modifier and Type
    Method
    Description
    Vector
    getCenter()
    Die aktuelle Position der Kamera.
    double
    getMeter()
    Gibt die Anzahl an Pixel aus, die einem Meter entsprechen.
    Vector
    getOffset()
    Gibt den Verzug der Kamera aus.
    double
    getRotation()
    Gibt die aktuelle Drehung zurück.
    boolean
    hasBounds()
    Gibt an, ob die Kamera durch Bounds in ihrer Bewegung beschränkt ist.
    boolean
    hasFocus()
    Gibt an, ob die Kamera ein Fokus-Objekt verfolgt oder „steif“ ist.
    void
    moveBy(double x, double y)
    Verschiebt die Kamera um einen bestimmten Wert in x- und y-Richtung (relativ).
    void
    moveBy(Vector vector)
    Verschiebt die Kamera um einen bestimmten Vektor (relativ).
    void
    moveTo(int x, int y)
    Verschiebt das Zentrum der Kamera zur angegebenen Position (absolute Verschiebung).
    void
    moveTo(Vector vector)
    Verschiebt das Zentrum der Kamera zur angegebenen Position (absolute Verschiebung).
    void
    onFrameUpdate()
    Implementiert den FrameUpdateListener nicht, da die Kamera an einem anderen Zeitpunkt aktualisiert wird.
    void
    removeFocus()
    Entfernt die fokussierte Figur von der Kamera.
    void
    rotateBy(double angle)
    Rotiert die Kamera um den angegebenen Winkel.
    void
    rotateTo(double angle)
    Setzt den Rotationswert der Kamera.
    void
    setBounds(Bounds bounds)
    Mit dieser Methode kann die Kamerabewegung eingeschränkt werden.
    void
    setCenter(double x, double y)
    Setzt die aktuelle Position der Kamera.
    void
    setCenter(Vector position)
    Setzt die aktuelle Position der Kamera.
    void
    setFocus(Actor focus)
    Setzt den Fokus der Kamera auf eine Figur.
    void
    setMeter(double pixelCount)
    Setzt die Anzahl an Pixel, die einem Meter entsprechen und setzt somit den „Zoom“ der Kamera.
    void
    setOffset(Vector offset)
    Setzt einen Kameraverzug.
    void
    setPostion(double x, double y)
    Setzt die aktuelle Position der Kamera.
    void
    zoomIn()
    Die Kamera bewegt sich um den Standard-Zoomfaktor näher an das Spielfeld.
    void
    zoomIn(double factor)
    Die Kamera bewegt sich näher an das Spielfeld.
    void
    zoomOut()
    Die Kamera entfernt sich um den Standard-Zoomfaktor vom Spielfeld.
    void
    zoomOut(double factor)
    Die Kamera entfernt sich vom Spielfeld.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_METER

      public static final double DEFAULT_METER
      Der Standardwert für die Anzahl an Pixel eines Meters.
      See Also:

    • DEFAULT_ZOOM_FACTOR

      public static final double DEFAULT_ZOOM_FACTOR
      See Also:

  • Constructor Details

    • Camera

      @Internal public Camera()
      Konstruktor erstellt eine neue Kamera mit Fokus auf (0, 0).

  • Method Details

    • setFocus

      @API public void setFocus(Actor focus)
      Setzt den Fokus der Kamera auf eine Figur.

      Dieses Objekt ist ab dann im „Zentrum“ der Kamera. Die Art des Fokus (rechts, links, oben, unten, mittig, etc.) kann über die Methode setOffset(Vector) geändert werden. Soll das Fokusverhalten beendet werden, kann einfach null übergeben werden, dann bleibt die Kamera bis auf Weiteres in der aktuellen Position.

      Parameters:
      focus - Die Figur, die fokussiert werden soll.

    • removeFocus

      @API public void removeFocus()
      Entfernt die fokussierte Figur von der Kamera.
      Since:
      0.28.0

    • hasFocus

      @API public boolean hasFocus()
      Gibt an, ob die Kamera ein Fokus-Objekt verfolgt oder „steif“ ist.
      Returns:
      true, wenn die Kamera ein Fokus-Objekt hat, sonst false.
      See Also:

    • setOffset

      @API public void setOffset(Vector offset)
      Setzt einen Kameraverzug. Der Standardwert hierfür ist (0, 0).

      Der Verzug ist ein Vektor, um den der Fokus verschoben wird. Das heißt, dass eine Figur im Fokus um 100 Pixel tiefer als im absoluten Bildzentrum liegt, wenn der Fokus-Verzug mit folgender Methode gesetzt wurde: camera.setOffset(new Vector(0, -100));

      Parameters:
      offset - Der Vektor, um den ab sofort die Kamera vom Zentrum des Fokus verschoben wird.

    • getOffset

      @API public Vector getOffset()
      Gibt den Verzug der Kamera aus.
      Returns:
      Der aktuelle Verzug der Kamera.
      See Also:

    • setBounds

      @API public void setBounds(Bounds bounds)
      Mit dieser Methode kann die Kamerabewegung eingeschränkt werden.

      Ein Rechteck gibt die Begrenzung an, die die Kameraperspektive niemals übertreten wird.

      Parameters:
      bounds - Das Rechteck, das die Grenzen der Kamera angibt.
      See Also:

    • hasBounds

      @API public boolean hasBounds()
      Gibt an, ob die Kamera durch Bounds in ihrer Bewegung beschränkt ist.
      Returns:
      true falls ja, sonst false.
      See Also:

    • setMeter

      @API public void setMeter(double pixelCount)
      Setzt die Anzahl an Pixel, die einem Meter entsprechen und setzt somit den „Zoom“ der Kamera.

      Die Anzahl an Pixel eines Meters bestimmt wie „nah“ oder „fern“ die Kamera an der Zeichenebene ist. Der Standardwert eines Meters ist 32 Pixel. Größer Werte zoomen näher an die Spielfläche heran, kleine Werte weiter von der Spielfläche weg.

      Parameters:
      pixelCount - Die neue Anzahl an Pixel, die einem Meter entsprechen.
      See Also:

    • zoomIn

      @API public void zoomIn(double factor)
      Die Kamera bewegt sich näher an das Spielfeld. Die Ansicht wird vergrößert.
      Parameters:
      factor - 1 verdoppelt die Pixelanzahl eines Meters, 0 keine Veränderung.
      Since:
      0.28.0

    • zoomIn

      @API public void zoomIn()
      Die Kamera bewegt sich um den Standard-Zoomfaktor näher an das Spielfeld. Die Ansicht wird vergrößert.
      Since:
      0.28.0

    • zoomOut

      @API public void zoomOut(double factor)
      Die Kamera entfernt sich vom Spielfeld. Die Ansicht wird verkleinert.
      Parameters:
      factor - 0.5 halbiert die Pixelanzahl eines Meters, 0 keine Veränderung.
      Since:
      0.28.0

    • zoomOut

      @API public void zoomOut()
      Die Kamera entfernt sich um den Standard-Zoomfaktor vom Spielfeld. Die Ansicht wird verkleinert.
      Since:
      0.28.0

    • getMeter

      @API public double getMeter()
      Gibt die Anzahl an Pixel aus, die einem Meter entsprechen.

      Ist die Pixelvervielfältigung aktiviert, wird der Faktor der Pixelvervielfältigung mit der Pixelanzahl multipliziert

      Returns:
      Die Anzahl an Pixel aus, die einem Meter entsprechen.
      See Also:

    • moveBy

      @API public void moveBy(Vector vector)
      Verschiebt die Kamera um einen bestimmten Vektor (relativ).
      Parameters:
      vector - Die Verschiebung als Vektor.

    • moveBy

      @API public void moveBy(double x, double y)
      Verschiebt die Kamera um einen bestimmten Wert in x- und y-Richtung (relativ).
      Parameters:
      x - Die Verschiebung in x-Richtung.
      y - Die Verschiebung in y-Richtung.

    • moveTo

      @API public void moveTo(Vector vector)
      Verschiebt das Zentrum der Kamera zur angegebenen Position (absolute Verschiebung). Von nun an ist der Punkt mit den eingegebenen Koordinaten im Zentrum des Bildes.
      Parameters:
      vector - Das neue Zentrum der Kamera.

    • moveTo

      @API public void moveTo(int x, int y)
      Verschiebt das Zentrum der Kamera zur angegebenen Position (absolute Verschiebung). Von nun an ist der Punkt mit den eingegebenen Koordinaten im Zentrum des Bildes.
      Parameters:
      x - Die x-Koordinate des Zentrums des Bildes.
      y - Die y-Koordinate des Zentrums des Bildes.

    • rotateBy

      @API public void rotateBy(double angle)
      Rotiert die Kamera um den angegebenen Winkel.

      Positive Werte drehen die die Kamera gegen den Uhrzeigersinn, negative im Uhrzeigersinn.

      Parameters:
      angle - Der Winkel (in Grad), um den die Kamera rotiert werden soll.
      • Werte > 0 : Drehung gegen Uhrzeigersinn
      • Werte < 0 : Drehung im Uhrzeigersinn

    • rotateTo

      @API public void rotateTo(double angle)
      Setzt den Rotationswert der Kamera. rotateTo(90) dreht die Kamera beispiels um 90 Grad gegen den Uhrzeigersinn, rotateTo(-90) um 90 Grad im Uhrzeigersinn.
      Parameters:
      angle - Der Winkel (in Grad), um die Kamera von seiner Ausgangsposition bei Initialisierung rotiert werden soll.

    • setPostion

      @API public void setPostion(double x, double y)
      Setzt die aktuelle Position der Kamera.
      Parameters:
      x - Die neue X-Koordinate des Kamerazentrums.
      y - Die neue Y-Koordinate des Kamerazentrums.
      See Also:

    • setCenter

      @API public void setCenter(double x, double y)
      Setzt die aktuelle Position der Kamera.
      Parameters:
      x - Die neue X-Koordinate des Kamerazentrums.
      y - Die neue Y-Koordinate des Kamerazentrums.
      Since:
      0.33.0
      See Also:

    • setCenter

      @API public void setCenter(Vector position)
      Setzt die aktuelle Position der Kamera.
      Parameters:
      position - Die neue Position der Kamera.

    • getCenter

      @API public Vector getCenter()
      Die aktuelle Position der Kamera.
      Returns:
      Die aktuelle Position der Kamera.

    • onFrameUpdate

      public void onFrameUpdate()
      Implementiert den FrameUpdateListener nicht, da die Kamera an einem anderen Zeitpunkt aktualisiert wird.

    • getRotation

      public double getRotation()
      Gibt die aktuelle Drehung zurück.
      Returns:
      Die aktuelle Drehung.