Package pi.graphics.boxes_ng

Class CompassBox

java.lang.Object
pi.graphics.boxes_ng.Box
pi.graphics.boxes_ng.LeafBox
pi.graphics.boxes_ng.CompassBox
All Implemented Interfaces:
Iterable<Box>
public class CompassBox extends LeafBox
Ein Kompasspfeil, der in der Mitte eines Quadrats angebracht ist.
Since:
0.42.0
Author:
Josef Friedrich

  • Constructor Details

    • CompassBox

      public CompassBox(double size)
      Erstellt einen neuen Kompasspfeil mit der angegebenen Seitenlänge.
      Parameters:
      size - Die Seitenlänge des Quadrats in Pixel, in das der Kompasspfeil eingepasst ist.

  • Method Details

    • size

      @Getter public int size()
      Gibt die Seitenlänge des Quadrats in Pixel zurück.
      Returns:
      Die Seitenlänge des Quadrats in Pixel.
      Since:
      0.53.0

    • size

      @Setter @ChainableMethod public CompassBox size(double size)
      Setzt die Seitenlänge des Quadrats in Pixel.
      Parameters:
      size - Die neue Seitenlänge des Quadrats in Pixel.
      Returns:
      Eine Referenz auf die eigene Instanz des Kompasses, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften des Kompasses durch aneinander gekettete Setter festgelegt werden können, z.B. compass.size(..).showOuterCircle(..).
      Since:
      0.53.0

    • direction

      @Setter @ChainableMethod public CompassBox direction(double direction)
      Setzt die Richtung der Kompassnadel in Grad.
      Parameters:
      direction - Die Richtung in Grad, in der die Kompassnadel zeigt.
      • 0 = nach rechts
      • 90 = nach oben
      • 180 = nach links
      • 270 = nach unten
      Returns:
      Eine Referenz auf die eigene Instanz des Kompasses, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften des Kompasses durch aneinander gekettete Setter festgelegt werden können, z.B. compass.size(..).showOuterCircle(..).

    • showCenter

      @Setter @ChainableMethod public CompassBox showCenter(boolean showCenter)
      Legt fest, ob der Mittelpunkt des Kompasspfeils sichtbar ist.
      Parameters:
      showCenter - true, wenn der Mittelpunkt angezeigt werden soll, sonst false.
      Returns:
      Eine Referenz auf die eigene Instanz des Kompasses, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften des Kompasses durch aneinander gekettete Setter festgelegt werden können, z.B. compass.size(..).showOuterCircle(..).

    • showOuterCircle

      @Setter @ChainableMethod public CompassBox showOuterCircle(boolean showOuterCircle)
      Legt fest, ob der äußere Kreis um den Kompasspfeil angezeigt wird.
      Parameters:
      showOuterCircle - true, wenn der äußere Kreis angezeigt werden soll, sonst false.
      Returns:
      Eine Referenz auf die eigene Instanz des Kompasses, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften des Kompasses durch aneinander gekettete Setter festgelegt werden können, z.B. compass.size(..).showOuterCircle(..).

    • showOuterCircle

      @Setter @ChainableMethod public CompassBox showOuterCircle()
      Zeigt den äußeren Kreis an.
      Returns:
      Eine Referenz auf die eigene Instanz des Kompasses, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften des Kompasses durch aneinander gekettete Setter festgelegt werden können, z.B. compass.size(..).showOuterCircle(..).

    • radius

      @Getter public double radius()
      Gibt den Radius des äußeren Kreises, also die Entfernung zur Mitte des Quadrats, also die Hälfte der Seitenlänge des Quadrats.
      Returns:
      Der Radius des äußeren Kreises, also die Entfernung zur Mitte des Quadrats, also die Hälfte der Seitenlänge des Quadrats.

    • center

      @Getter public Vector center()
      Gibt den Mittelpunkt des Rahmenquadrats.
      Returns:
      Der Mittelpunkt des Rahmenquadrats.