Maus (Engine Alpha)

java.lang.Object
- ea.Maus

```
public class Maus
extends java.lang.Object
```
Klasse zur Kontrolle der Maus

Author:

Michael Andonie, Niklas Keller

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Maus.Auftrag
Diese Klasse sammelt die Auftraege der KlickReagierbar-Interfaces.

Nested Classes
Modifier and Type	Class and Description
`class`	`Maus.Auftrag` Diese Klasse sammelt die Auftraege der KlickReagierbar-Interfaces.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TYPE_FADENKREUZ` Ein Fadenkreuz
`static int`	`TYPE_HAND` Ein klassischer Zeiger, der eine Hand darstellt mit einem Zeigefinger
`static int`	`TYPE_KLASSIK` Ein klassischer Zeiger, wie unter Windows gewohnt
`static int`	`TYPE_STANDARD` Standard-Maus-Zeiger der Engine Alpha

Constructor Summary

Constructors
Constructor and Description
`Maus(int type)` Vereinfachter Konstruktor für eine Standard-Maus.
`Maus(int type, boolean fixed, boolean bewegend)` Vollständiger Konstruktor für eine Standard-Maus.
`Maus(Raum mausbild, Punkt hotspot)` Erstellt eine Maus, die die Kamera nicht bewegt und nicht fixiert ist.
`Maus(Raum mausbild, Punkt hotspot, boolean fixed)` Dieser Konstruktor ist lediglich eine Vereinfachung.
`Maus(Raum mausbild, Punkt hotspot, boolean fixed, boolean bewegend)` Dieser Konstruktor ermöglicht es, ein eigenes Mausbild einzubringen.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`absolut()`
`void`	`anmelden(MausReagierbar m, Raum objekt, int code)` Meldet ein Raumobjekt zum Ueberwachen an einem bestimmten Listener an, unter Eingabe eines bestimmten Codes.
`boolean`	`bewegend()`
`void`	`bewegt(Vektor bewegung)` Benachrichtigt alle Listener, falls die Bewegung nicht (0\|0) war.
`void`	`entfernen(MausReagierbar g)` Entfernt ein bestimmtes MausReagierbar-Interface gaenzlich von Kollisionstest. Heisst das also, dass mehrere verschiedene Raum-Objekte an dem uebergebenen Objekt Ueberwacht werden, so wird ab sofort fuer keines mehr eine Benachrichtigung stattfinden.
`void`	`fensterSetzen(Fenster f)` Setzt die Referenz auf das Fenster, in dem diese Maus sitzt, neu.
`Raum`	`getImage()` Berechnet das Bild von der Maus, das in der Engine dargestellt wird.
`Punkt`	`hotSpot()`
`void`	`klick(Punkt p, boolean links)` Bei einer angemeldeten Maus wird bei einem Klick diese Methode aufgerufen. Theoretisch liessen sich so Tastenklicks "simulieren".
`void`	`klick(Punkt p, boolean links, boolean losgelassen)` Bei einer angemeldeten Maus wird bei einem Klick diese Methode aufgerufen. So lassen sich auch Klicks auf die Maus "simulieren".
`Punkt`	`klickAufZeichenebene()` Gibt den Punkt auf der Zeichenebene aus, auf den die Maus bei einem Klick zeigen würde.
`void`	`klickReagierbarAnmelden(KlickReagierbar k)` Meldet ein KlickReagierbar bei der Maus an. Ab dann wird es bei jedem Mausklick (Linksklick) in der Engine benachrichtigt.
`void`	`mausBewegungReagierbarAnmelden(MausBewegungReagierbar m)` Meldet ein `MausBewegungReagierbar`-Objekt bei der Maus an.
`void`	`mausLosgelassenReagierbarAnmelden(MausLosgelassenReagierbar m)` Meldet ein `MausLosgelassenReagierbar`-Objekt bei der Maus an.
`void`	`mausReagierbarAnmelden(MausReagierbar m, Raum objekt)` Alternativmethopde zum anmelden.
`java.util.ArrayList<Maus.Auftrag>`	`mausReagierbarListe()` Gibt die Liste aller Auftraege (interne Klasse!!) fuer MausReagierbar- Interfaces ACHTUNG Die ArrayList ist verantwortlich fuer die MausReagierbar-Aktionen.
`void`	`rechtsKlickReagierbarAnmelden(RechtsKlickReagierbar k)` Meldet ein RechtsKlickReagierbar-Objekt bei der Maus an. Ab dann wird es bei jedem Rechtsklick benachrichtigt.
`void`	`uebernehmeAlleListener(Maus von)` Uebernimmt alle Listener von einer anderen Maus.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_STANDARD
```
public static final int TYPE_STANDARD
```
    Standard-Maus-Zeiger der Engine Alpha
    
    See Also:
    
    Constant Field Values
  - TYPE_FADENKREUZ
```
public static final int TYPE_FADENKREUZ
```
    Ein Fadenkreuz
    
    See Also:
    
    Constant Field Values
  - TYPE_HAND
```
public static final int TYPE_HAND
```
    Ein klassischer Zeiger, der eine Hand darstellt mit einem Zeigefinger
    
    See Also:
    
    Constant Field Values
  - TYPE_KLASSIK
```
public static final int TYPE_KLASSIK
```
    Ein klassischer Zeiger, wie unter Windows gewohnt
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Maus
```
@API
public Maus(Raum mausbild,
                 Punkt hotspot,
                 boolean fixed)
```
    Dieser Konstruktor ist lediglich eine Vereinfachung. Siehe Dokumentation des vollständigen Konstruktors für eine Dokumentation der Parameter: Maus(Raum, Punkt, boolean, boolean)
    bewegend wird bei diesem Konstruktor auf false gesetzt.
    
    Parameters:
    
    mausbild - siehe Maus(Raum, Punkt, boolean, boolean)
    
    hotspot - siehe Maus(Raum, Punkt, boolean, boolean)
    
    fixed - siehe Maus(Raum, Punkt, boolean, boolean)
    
    See Also:
    
    Maus(Raum, Punkt, boolean, boolean), Bild, Kamera
  - Maus
```
@API
public Maus(Raum mausbild,
                 Punkt hotspot,
                 boolean fixed,
                 boolean bewegend)
```
    Dieser Konstruktor ermöglicht es, ein eigenes Mausbild einzubringen.
    Hierfür muss klar sein, was ein Hotspot ist:
    Ein Hotspot ist ein Punkt, relativ entfernt von der linken oberen Ecke des Mausbildes. Dieser Punkt ist der eigentliche Klickpunkt.
    Angenommen das Mausbild misst 20 x 20 Pixel und der Hotspot ist ein Punkt mit den Koordinaten (10|10), so wäre der Hotspot in der Mitte des Bildes und bei einem Klick wären diese Klick-Koordinaten genau in der Mitte. Wäre der Hotspot (0|0), so wäre der Hotspot genau die linke obere Ecke des Mausbildes.
    Parameters:
    
    mausbild - Das Objekt, das ab sofort das Mausbild sein wird und auch dementsprechend bewegt wird.
    
    hotspot - Der bereits beschriebene Hotspot
    
    fixed - Ob diese Maus fixiert sein soll: Ist dieser Wert true, so ist die Maus immer in der Mitte. Bei false verhält sich diese Maus genauso wie gewohnt.
    bewegend - Regelt, ob die Kamera bei Mausbewegungen bewegt wird.
    Bei true:
    
    Falls die Maus fixiert ist, bleibt sie weiterhin in der Mitte und die Kamera wird bei jeder Bewegung bewegt.
    
    Falls die Maus nicht fixiert ist, so wird die Kamera erst bewegt, wenn die Maus den Rand des Fensters beführt.
    
    Bei false wird die Kamera nie automatisch bewegt. Allerdings ist dies über das Interface MausBewegungReagierbar manuell realisierbar. Ohne dieses Interface gibt false bei einer fixierten Maus wenig Sinn.
    See Also:
    
    Bild, Kamera
  - Maus
```
@API
public Maus(Raum mausbild,
                 Punkt hotspot)
```
    Erstellt eine Maus, die die Kamera nicht bewegt und nicht fixiert ist.
    Weitere Erläuterungen: Maus(Raum, Punkt, boolean, boolean)
    
    Parameters:
    
    mausbild - siehe Maus(Raum, Punkt, boolean, boolean)
    
    hotspot - siehe Maus(Raum, Punkt, boolean, boolean)
    
    See Also:
    
    Maus(Raum, Punkt, boolean)
  - Maus
```
@API
public Maus(int type)
```
    Vereinfachter Konstruktor für eine Standard-Maus.
    Hierbei gibt es verschiedene Mäuse, die über ihren Index gewählt werden können. Die verlinkten Konstanten sollten verständlich dokumentiert sein. Ansonsten ist an dieser Stelle auch das Wiki hilfreich.
    Die Maus ist dabei weder fixiert noch wird die Kamera durch ihre Bewegung bewegt.
    
    Parameters:
    
    type - Die Art der Maus. Jeder Wert steht für eine andere Maus.
    TYPE_STANDARD, TYPE_FADENKREUZ, TYPE_HAND oder TYPE_KLASSIK
  - Maus
```
@API
public Maus(int type,
                 boolean fixed,
                 boolean bewegend)
```
    Vollständiger Konstruktor für eine Standard-Maus.
    Hierbei gibt es verschiedene Mäuse, die über ihren Index gewählt werden können. Die verlinkten Konstanten sollten verständlich dokumentiert sein. Ansonsten ist an dieser Stelle auch das Wiki hilfreich.
    
    Parameters:
    
    type - Die Art der Maus. Jeder Wert steht für eine andere Maus.
    TYPE_STANDARD, TYPE_FADENKREUZ, TYPE_HAND oder TYPE_KLASSIK
    
    fixed - Ob diese Maus fixiert sein soll: Ist dieser Wert true, so ist die Maus immer in der Mitte. Bei false verhält sich diese Maus genauso wie gewohnt.
    
    bewegend - Ob die Maus die Kamera bewegen koennen soll oder nicht.
- Method Detail
  - getImage
```
public Raum getImage()
```
    Berechnet das Bild von der Maus, das in der Engine dargestellt wird.
    
    Returns:
    
    Das Bild des Mauscursors.
  - hotSpot
```
public Punkt hotSpot()
```
    Returns:
    
    der Punkt auf dem Mausbild, der als Hotspot fungiert.
  - fensterSetzen
```
public void fensterSetzen(Fenster f)
```
    Setzt die Referenz auf das Fenster, in dem diese Maus sitzt, neu. ACHTUNG: Sollte nicht von Außen benutzt werden, falls man sich nicht genau mit der Struktur der Engine auskennt.
    
    Parameters:
    
    f - Die neue Fensterreferenz.
  - mausReagierbarAnmelden
```
public void mausReagierbarAnmelden(MausReagierbar m,
                                   Raum objekt)
```
    Alternativmethopde zum anmelden. Hierbei gibt es keinen Code-Parameter; dieser wird automatisch auf 0 gesetzt.
    
    Parameters:
    
    m - Der anzumeldende Listener
    
    objekt - Das zu auf Klicks zu ueberwachende Objekt
    
    See Also:
    
    anmelden(MausReagierbar, Raum, int)
  - anmelden
```
public void anmelden(MausReagierbar m,
                     Raum objekt,
                     int code)
```
    Meldet ein Raumobjekt zum Ueberwachen an einem bestimmten Listener an, unter Eingabe eines bestimmten Codes.
    
    Parameters:
    
    m - Das Listener-Objekt, dass bei Kollision benachrichtigt werden soll.
    
    objekt - Das auf Klick zu ueberwachende Raum-Objekt
    
    code - Der Code, mit dem ein Klick auf dieses Objekt assoziiert wird.
    Diese Zahl wird als Argument bei der Reaktionsmethode mitgegeben, wodurch, bei korrekten Programmierorganisation dieser Zahlen, eine sehr gute Unterscheidung ohne groesseren Methodenaufwand noetig ist.
    
    See Also:
    
    MausReagierbar.mausReagieren(int)
  - uebernehmeAlleListener
```
public void uebernehmeAlleListener(Maus von)
```
    Uebernimmt alle Listener von einer anderen Maus.
    
    Parameters:
    
    von - Von dieser Maus, werden alle Listener-Listen übernommen. Bereits vorhandene Listener bleiben dabei erhalten, werden aber eventuell DOPPELT eingefügt.
  - klickReagierbarAnmelden
```
public void klickReagierbarAnmelden(KlickReagierbar k)
```
    Meldet ein KlickReagierbar bei der Maus an.
    Ab dann wird es bei jedem Mausklick (Linksklick) in der Engine benachrichtigt.
    
    Parameters:
    
    k - Das anzumeldende KlickReagierbar-Interface
  - rechtsKlickReagierbarAnmelden
```
public void rechtsKlickReagierbarAnmelden(RechtsKlickReagierbar k)
```
    Meldet ein RechtsKlickReagierbar-Objekt bei der Maus an.
    Ab dann wird es bei jedem Rechtsklick benachrichtigt.
    
    Parameters:
    
    k - Das anzumeldende RechtsKlickReagierbar-Interface
  - mausLosgelassenReagierbarAnmelden
```
public void mausLosgelassenReagierbarAnmelden(MausLosgelassenReagierbar m)
```
    Meldet ein MausLosgelassenReagierbar-Objekt bei der Maus an.
    Ab dann wird es jedes mal durch Aufruf seiner Methode benachrichtigt, wenn eine Maustaste losgelassen wird.
    
    Parameters:
    
    m - Listener-Objekt
  - mausBewegungReagierbarAnmelden
```
public void mausBewegungReagierbarAnmelden(MausBewegungReagierbar m)
```
    Meldet ein MausBewegungReagierbar-Objekt bei der Maus an.
    Ab dann wird es jedes mal durch Aufruf seiner Methode benachrichtigt, wenn die Maus bewegt wird.
    
    Parameters:
    
    m - Listener-Objekt
  - klick
```
public void klick(Punkt p,
                  boolean links)
```
    Bei einer angemeldeten Maus wird bei einem Klick diese Methode aufgerufen.
    Theoretisch liessen sich so Tastenklicks "simulieren".
    
    Parameters:
    
    p - der respektive Punkt für den simulierten Mausklick.
    
    links - War der Klick ein Linksklick, ist dieser Wert true. Fuer jede andere Klickart ist dieser Wert false. In diesem Fall wird mit einem Rechtsklick gerechnet.
    
    See Also:
    
    ea.Maus#klick(int, int, boolean, boolean)
  - klick
```
public void klick(Punkt p,
                  boolean links,
                  boolean losgelassen)
```
    Bei einer angemeldeten Maus wird bei einem Klick diese Methode aufgerufen.
    So lassen sich auch Klicks auf die Maus "simulieren".
    
    Parameters:
    
    p - der Punkt des Klicks
    
    links - War der Klick ein Linksklick, ist dieser Wert true. Fuer jede andere Klickart ist dieser Wert false. In diesem Fall wird mit einem Rechtsklick gerechnet.
    
    losgelassen - ist dieser Wert true, so wird dies als losgelassene Taste behandelt.
  - bewegt
```
public void bewegt(Vektor bewegung)
```
    Benachrichtigt alle Listener, falls die Bewegung nicht (0|0) war.
    
    Parameters:
    
    bewegung - der Vektor, der die Bewegung der Maus beschreibt.
  - entfernen
```
public void entfernen(MausReagierbar g)
```
    Entfernt ein bestimmtes MausReagierbar-Interface gaenzlich von Kollisionstest.
    Heisst das also, dass mehrere verschiedene Raum-Objekte an dem uebergebenen Objekt Ueberwacht werden, so wird ab sofort fuer keines mehr eine Benachrichtigung stattfinden.
    
    Parameters:
    
    g - Das gaenzlich von Klick-Tests zu entfernende MausReagierbar-Interface
  - bewegend
```
public boolean bewegend()
```
    Returns:
    
    Ob die Maus den Bildschirm bewegen kann
  - klickAufZeichenebene
```
public Punkt klickAufZeichenebene()
```
    Gibt den Punkt auf der Zeichenebene aus, auf den die Maus bei einem Klick zeigen würde. Diese Methode rechnet alle Umstände der Maus (z.B. relativ bzw. fixed) mit ein und gibt die genaue Position des Klicks zurück.
    
    Returns:
    
    Der genaue Punkt auf der Zeichenebene, auf den diese Maus bei einem Klick deuten würde.
  - absolut
```
public boolean absolut()
```
    Returns:
    
    Ob die Maus fixed ist oder nicht.
  - mausReagierbarListe
```
public java.util.ArrayList<Maus.Auftrag> mausReagierbarListe()
```
    Gibt die Liste aller Auftraege (interne Klasse!!) fuer MausReagierbar- Interfaces
    
    ACHTUNG Die ArrayList ist verantwortlich fuer die MausReagierbar-Aktionen. Daher stellt die Verwendung dieses Objekts durchaus eine Fehlerquelle dar.
    
    Returns:
    
    die Liste aller MausReagierbar-Auftraege
    
    See Also:
    
    Maus.Auftrag

Class Maus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_STANDARD

TYPE_FADENKREUZ

TYPE_HAND

TYPE_KLASSIK

Constructor Detail

Maus

Maus

Maus

Maus

Maus

Method Detail

getImage

hotSpot

fensterSetzen

mausReagierbarAnmelden

anmelden

uebernehmeAlleListener

klickReagierbarAnmelden

rechtsKlickReagierbarAnmelden

mausLosgelassenReagierbarAnmelden

mausBewegungReagierbarAnmelden

klick

klick

bewegt

entfernen

bewegend

klickAufZeichenebene

absolut

mausReagierbarListe