Package pi.graphics

Class SceneInfoOverlay

java.lang.Object
pi.graphics.SceneInfoOverlay
public class SceneInfoOverlay extends Object
Eine Infobox, die über eine Szene gelegt werden kann.

Sie wird standardmäßig nach einer gewissen Zeit wieder ausgeblendet.

Die Infobox kann vier Zeichenketten enthalten:

  • title: Der Titel der Szene.
  • subtitle: Der Untertitel der Szene.
  • description: Ein längerer, mehrzeiliger Beschreibungstext zur Szene.
  • help: Ein längerer, mehrzeiliger Hilfetext zur Szene.
Since:
0.42.0
Author:
Josef Friedrich
See Also:

  • Field Details

  • Constructor Details

    • SceneInfoOverlay

      public SceneInfoOverlay(Scene scene)

  • Method Details

    • permanent

      @API @Setter public SceneInfoOverlay permanent()
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • duration

      @API @Setter public SceneInfoOverlay duration(double duration)
      Setzt die Anzeigedauer der Infobox in Sekunden.
      Parameters:
      duration - Die Anzeigedauer der Infobox in Sekunden.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • title

      @Setter @API public SceneInfoOverlay title(String title)
      Setzt den Titel der Szene.

      Der Titel wird als Einblendung über die Szene gelegt.

      Parameters:
      title - Der Titel der Szene.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • subtitle

      @Setter @API public SceneInfoOverlay subtitle(String subtitle)
      Setzt den Untertitel der Szene.

      Der Untertitel wird als Einblendung über die Szene gelegt.

      Parameters:
      subtitle - Der Untertitel der Szene.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • description

      @Setter @API public SceneInfoOverlay description(String description)
      Setzt den längerer, mehrzeiliger Beschreibungstext zur Szene.

      Der Beschreibungstext wird als Einblendung über die Szene gelegt.

      Parameters:
      description - Ein längerer, mehrzeiliger Beschreibungstext zur Szene.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • help

      @Setter @API public SceneInfoOverlay help(String help)
      Setzt den Hilfetext zur Szene.

      Der Beschreibungstext wird als Einblendung über die Szene gelegt.

      Parameters:
      help - Ein Hilfetext zur Szene.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • textColor

      @Setter @API public SceneInfoOverlay textColor(Color textColor)
      Setzt die Textfarbe.
      Parameters:
      textColor - die Textfarbe.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0

    • hAlign

      @Setter @API public SceneInfoOverlay hAlign(HAlign hAlign)
      Setzt die horizontale Ausrichtung der Infobox.
      Parameters:
      hAlign - Die horizontale Ausrichtung der Infobox.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).

    • vAlign

      @Setter @API public SceneInfoOverlay vAlign(VAlign vAlign)
      Setzt die vertikale Ausrichtung der Infobox.
      Parameters:
      vAlign - Die vertikale Ausrichtung der Infobox.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).

    • disable

      @API public SceneInfoOverlay disable()
      Deaktiviert die Infobox der Szene.

      Die Infobox wird nicht angezeigt.

      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).

    • toggle

      @API public SceneInfoOverlay toggle()
      Schaltet zwischen dem Status deaktiviert und aktiviert hin- und her.
      Returns:
      Eine Referenz auf die eigene Instanz, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften durch aneinander gekettete Setter festgelegt werden können, z. B. info().title(..).subtitle(..).
      Since:
      0.42.0