ea

Class Figur

java.lang.Object

ea.Raum

ea.Figur

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Raum>

Direct Known Subclasses:

FigurE

public class Figur
extends Raum

Eine Figur ist eine aus einer Datei geladene Sammlung von Pixeln, die orientierungsmaessig rechteckig gehandelt werden.
//Die Figur laden
Figur meineFigur = new Figur(30, 100, "meineFigurDateiImProjektordner.eaf"); //Laedt die Figur und setzt sie an Position (30|100)

//Die Bewegung der Figur starten (muss nicht ausgefuehrt werden, Sa standard)
meineFigur.animiertSetzen(true);

// Die Figur an dem entsprechenden Knoten zum halten und Zeichnen anmelden (In diesem Fall die Wurzel in der Klasse Game)
wurzel.add(meineFigur);



Dies ist einfachste Methode, eine Figur zu laden.
Der Figureneditor zum Erstellen der zu ladenden ".eaf"-Dateien ist als ausfuehrbare ".jar"-Datei fester Bestandteil des Engine-Alpha-Programmierkits.

Author:

Michael Andonie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PixelFeld[]	animation Die einzelnen Bilder der Figur. hat es mehr als eines, so wird ein periodischer Wechsel vollzogen.

Fields inherited from class ea.Raum

farbzyklus, position, roh

Constructor Summary

Constructors

Constructor and Description
Figur() Der parameterlose Konstruktor. Hiebei wird nichts gesetzt, die Figur hat die Position (0|0) sowie keine Animationen, die Referenz auf die einzelnen Pixelfelder ist null. Dieser Konstruktor wird intern verwendet, um Figurdaten zu laden. Daher ist er nicht für die direkte Verwendung in Spielen gedacht.
Figur(float x, float y, java.lang.String verzeichnis) Standart-Konstruktor für Objekte der Klasse Figur.
Figur(float x, float y, java.lang.String verzeichnis, boolean add) Besonderer Konstruktor fuer Objekte der Klasse Figur.
Figur(java.lang.String verzeichnis) Erstellt eine Figur ohne Positionsangabe.

Method Summary

Modifier and Type	Method and Description
int	aktuellesBild() Gibt den Index des aktuellen Bildes zurueck. Die Figur, die im Pixelfeldeditor erstellt wurde besteht den Bildern (1, 2, ..., n), aber ACHTUNG, die Indizes fangen bei 0 an und hoeren dann eins frueher auf (0, 1, ..., (n-1)).
PixelFeld[]	animation()
void	animationLoeschen(int index) Löscht ein Animationsbild an einem bestimmten Index und rückt den Rest nach.
void	animationsBildSetzen(int bildIndex) Setzt das aktuelle Animationsbild. Die Figur, die im Pixelfeldeditor erstellt wurde besteht den Bildern (1, 2, ..., n), aber ACHTUNG, die Indizes fangen bei 0 an und hören dann eins frueher auf (0, 1, ..., (n-1)).
void	animationsBildSetzen(PixelFeld bild, int index) Setzt das Animationsbild auf einer bestimmten Position auf ein neues Pixelfeld.
void	animationsBildVerschieben(int indexAlt, int indexNeu) Verschiebt die Position eines Animationsbildes. Hierbei wird ein bisschen mit den Werten des Arrays gespielt, jedoch kein neues Array erstellt.
void	animationSetzen(PixelFeld[] a) Setzt eine neue Animationsreihe.
void	animationsGeschwindigkeitSetzen(int intervall) Setzt die Geschwindigkeit der Animation, die diese Figur Figuren steuert. Jed groesser Die Zahl ist, desto langsamer laeuft die Animation, da der Eingabeparamter die Wartezeit zwischen der Schaltung der Animationsbilder in Millisekunden angibt!
void	animationsSchritt(int runde) Ruft das naechste Bild im Animationszyklus auf. Sollte nicht von aussen aufgerufen werden, stellt aber in keinem mathematisch greifbaren Fall ein Problem dar.
boolean	animiert() Gibt an, ob das Bild momentan animiert wird bzw.
void	animiertSetzen(boolean animiert) Setzt die Animationsarbeit bei dieser Figur.
BoundingRechteck	dimension() Methode zum Beschreiben der rechteckigen Fläche, die dieses Objekt einnimmt. Diese Methode wird zentral für die Trefferkollisionen innerhalb der Engine benutzt und gehört zu den wichtigsten Methoden der Klasse und der Engine.
void	dunkler() Dunkelt alle Farbwerte der Figur ab. Gegenstueck zur Methode heller(). Achtung: Wegen Rundungsfehlern muss der Aufruf von dunkler() nach dem Aufruf von heller() nicht zwanghaft zum urspruenglichen Zustand fuehren!
void	einfaerben(Farbe f) Faerbt alle Elemente in einer Farbe ein. Dieser Zustand laesst sich zuruecksetzen mit der Methode zurueckFaerben().
void	einfaerben(java.lang.String farbe) Faerbt alle Elemente in einer Farbe ein. Dieser Zustand laesst sich zuruecksetzen mit der Methode zurueckFaerben().
Collider	erzeugeCollider() Erzeugt einen neuen Collider für dieses Objekt.
void	faktorSetzen(int faktor) Setzt den Größenfaktor dieser Figur neu.
void	farbenTransformieren(int r, int g, int b) Sorgt fuer eine Farbtransformation. Das heißt, zu jeder Farbe der Figur werden die RGB-Werte um feste Betraege geaendert (positive oder negative).
BoundingRechteck[]	flaechen() Berechnet exakter alle Rechteckigen Flaechen, auf denen dieses Objekt liegt. Diese Methode wird von komplexeren Gebilden, wie geometrischen oder Listen ueberschrieben.
void	heller() Hellt alle Farbwerte der Figur auf. Gegenstück zur Methode dunkler(). Achtung: Wegen Rundungsfehlern muss der Aufruf von dunkler() nach dem Aufruf von heller() nicht zwanghaft zum urspruenglichen Zustand fuehren!
int	intervall() Gibt das Intervall dieser Figur zurueck.
void	negativ() Setzt sämtliche Farbwerte sämtlicher Bilder der Figur in ihr Negativ. Dadurch ändert sich die Erscheinung der Figur.
void	spiegelXSetzen(boolean spiegel) Setzt, ob diese Figur bei der Darstellung waagrecht zentral gespiegelt werden soll oder nicht. Dies aendert die Drehungsrichtung einer Figur von N nach S bzw.
void	spiegelYSetzen(boolean spiegel) Setzt, ob diese Figur bei der Darstellung senkrecht zentral gespiegelt werden soll oder nicht. So laesst sich extrem schnell z.B.
boolean	xGespiegelt() Diese Methode gibt aus, ob diese Figur derzeit an der X-Achse (waagrecht) gespiegelt ist.
boolean	yGespiegelt() Diese Methode gibt aus, ob diese Figur derzeit an der Y-Achse (senkrecht) gespiegelt ist.
void	zeichnen(java.awt.Graphics2D g, BoundingRechteck r) Zeichnet das Objekt.
void	zurueckFaerben() Sorgt dafuer, dass nach dem Aufruf von einfaerben(Farbe) die Figur wieder ihre normalen Farbgegebenheiten kriegt.

Methods inherited from class ea.Raum

afterRender, aktivMachen, aktuellerCollider, beeinflussbarSetzen, beforeRender, beinhaltet, bewegen, bewegen, boundsUebernehmen, colliderSetzen, compareTo, drehenAbsolut, drehenRelativ, einfluesseZuruecksetzen, erzeugeLazyCollider, fallReagierbarAnmelden, geschwindigkeitHinzunehmen, geschwindigkeitSetzen, getBreite, getForce, getHoehe, getMasse, getOpacity, getX, getY, gibDrehung, halbesAlpha, heavyComputingSetzen, hoehenUnterschied, impulsHinzunehmen, inFlaeche, istBeeinflussbar, konstanteKraftSetzen, kraftAnwenden, kritischeTiefeSetzen, leuchterAbmelden, leuchterAnmelden, loeschen, luftwiderstandskoeffizient, luftwiderstandskoeffizientSetzen, masseSetzen, mittelPunkt, mittelpunktSetzen, mittelpunktSetzen, neutralMachen, newtonschMachen, passivMachen, position, positionSetzen, positionSetzen, positionX, positionY, problem, schneidet, schwerkraftAktivSetzen, schwerkraftSetzen, setOpacity, setX, setY, setzeMeterProPixel, sichtbar, sichtbarSetzen, sprung, stehReagierbarAnmelden, steht, stehtAuf, verschieben, verschieben, zeichnenBasic, zentrum, zIndex, zuFarbeKonvertieren

Methods inherited from class java.lang.Object

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

Field Detail

animation

protected PixelFeld[] animation

Die einzelnen Bilder der Figur.
hat es mehr als eines, so wird ein periodischer Wechsel vollzogen.

Constructor Detail

Figur

public Figur(java.lang.String verzeichnis)

Erstellt eine Figur ohne Positionsangabe. Die Figur liegt an Position (0|0). Dieser Konstruktor vereinfacht das Laden vieler Figuren, z.B. für eine ActionFigur.

Parameters:

verzeichnis - Das Verzeichnis, aus dem die Figur zu laden ist.

See Also:

ActionFigur

Figur

public Figur(float x,
             float y,
             java.lang.String verzeichnis)

Standart-Konstruktor für Objekte der Klasse Figur.

Parameters:

x - X-Position; die links obere Ecke

y - Y-Position; die links obere Ecke

verzeichnis - Das verzeichnis, aus dem die Figur zu laden ist.

Figur

public Figur(float x,
             float y,
             java.lang.String verzeichnis,
             boolean add)

Besonderer Konstruktor fuer Objekte der Klasse Figur. Dieser Konstruktor wird vor allem intern (fuer Actionfiguren) verwendet. Anders ist nur die Option darauf, dass die Figur am Animationssystem direkt teilnimmt. Dies ist beim Standart-Konstruktor immer der Fall.

Parameters:

x - X-Position; die links obere Ecke

y - Y-Position; die links obere Ecke

verzeichnis - Das verzeichnis, aus dem die Figur zu laden ist.

add - Ob diese Figur am Animationssystem direkt teilnehmen soll. (Standard)

Figur

public Figur()

Der parameterlose Konstruktor.
Hiebei wird nichts gesetzt, die Figur hat die Position (0|0) sowie keine Animationen, die Referenz auf die einzelnen Pixelfelder ist null.
Dieser Konstruktor wird intern verwendet, um Figurdaten zu laden.
Daher ist er nicht für die direkte Verwendung in Spielen gedacht.

Method Detail

animationLoeschen

@API
public void animationLoeschen(int index)

Löscht ein Animationsbild an einem bestimmten Index und rückt den Rest nach.

Parameters:

index - Der Index des zu löschenden Einzelbildes.

Throws:

java.lang.ArrayIndexOutOfBoundsException - Wenn ein Index außerhalb der Größes des internen Arrays gewählt wurde.

java.lang.RuntimeException - Falls nur noch ein Element vorhanden war. Das letzte Element darf nicht entfernt werden!

animationsBildSetzen

@NoExternalUse
public void animationsBildSetzen(PixelFeld bild,
                                                int index)

Setzt das Animationsbild auf einer bestimmten Position auf ein neues Pixelfeld.

Parameters:

bild - Neues Pixelfeld an der angegebenen Position. Darf nicht null sein!

index - Index des zu ersetzenden Pixelfeldes

Throws:

java.lang.ArrayIndexOutOfBoundsException - Wenn ein Index außerhalb der Größes des internen Arrays gewählt wurde.

java.lang.IllegalArgumentException - Wenn der Parameter bild null war.

animationsBildVerschieben

@API
public void animationsBildVerschieben(int indexAlt,
                                           int indexNeu)

Verschiebt die Position eines Animationsbildes.
Hierbei wird ein bisschen mit den Werten des Arrays gespielt, jedoch kein neues Array erstellt. Sind beide Eingabeparameter exakt gleich, passiert gar nichts, auch wenn die beiden Werte außerhalb des Arrays liegen sollten.

Parameters:

indexAlt - Index des zu verschiebenden Bildes

indexNeu - Index, den das Bild nach dem verschieben haben soll.

Throws:

java.lang.ArrayIndexOutOfBoundsException - Wenn ein Index außerhalb der Größes des internen Arrays gewählt wurde.

animationsSchritt

@NoExternalUse
public void animationsSchritt(int runde)

Ruft das naechste Bild im Animationszyklus auf.
Sollte nicht von aussen aufgerufen werden, stellt aber in keinem mathematisch greifbaren Fall ein Problem dar.

Parameters:

runde - Die Runde dieses Schrittes; dieser Wert wird intern benoetigt, um zu entscheiden, ob etwas passieren soll oder nicht.

animationSetzen

public void animationSetzen(PixelFeld[] a)

Setzt eine neue Animationsreihe.

Parameters:

a - Die neue Animationsreihe. Das Array muss mindestens ein Pixelfeld zum Inhalt haben
Diese muss aus Pixelfeldern gleicher Maße bestehen!

Throws:

java.lang.IllegalArgumentException - Falls animation null war oder keine Elemente enthalten hat.

animiertSetzen

public void animiertSetzen(boolean animiert)

Setzt die Animationsarbeit bei dieser Figur.

Parameters:

animiert - ob die Figur animiert werden soll, oder ob sie ein Standbild sein soll.

animiert

public boolean animiert()

Gibt an, ob das Bild momentan animiert wird bzw. animiert werden soll.

animationsBildSetzen

public void animationsBildSetzen(int bildIndex)

Setzt das aktuelle Animationsbild.
Die Figur, die im Pixelfeldeditor erstellt wurde besteht den Bildern (1, 2, ..., n), aber ACHTUNG, die Indizes fangen bei 0 an und hören dann eins frueher auf (0, 1, ..., (n-1)). Das heißt, dass wenn als Index 5 eingegeben wird, ist das Bild gemeint, das im Figureneditor als Bild 6 bezeichnet wurde.

Parameters:

bildIndex - Der Index des anzuzeigenden Bildes

faktorSetzen

public void faktorSetzen(int faktor)

Setzt den Größenfaktor dieser Figur neu.

Das heisst, ab sofort wird ein Unterquadrat dieser Figur eine Seitenlänge von Pixeln in Größe des Faktors haben

Parameters:

faktor - Der neue Größenfaktor

negativ

public void negativ()

Setzt sämtliche Farbwerte sämtlicher Bilder der Figur in ihr Negativ.
Dadurch ändert sich die Erscheinung der Figur.

See Also:

heller(), dunkler(), farbenTransformieren(int, int, int)

heller

public void heller()

Hellt alle Farbwerte der Figur auf.
Gegenstück zur Methode dunkler().
Achtung:
Wegen Rundungsfehlern muss der Aufruf von dunkler() nach dem Aufruf von heller() nicht zwanghaft zum urspruenglichen Zustand fuehren!

See Also:

dunkler(), negativ(), farbenTransformieren(int, int, int)

dunkler

public void dunkler()

Dunkelt alle Farbwerte der Figur ab.
Gegenstueck zur Methode heller().
Achtung:
Wegen Rundungsfehlern muss der Aufruf von dunkler() nach dem Aufruf von heller() nicht zwanghaft zum urspruenglichen Zustand fuehren!

See Also:

heller(), negativ(), farbenTransformieren(int, int, int)

farbenTransformieren

public void farbenTransformieren(int r,
                                 int g,
                                 int b)

Sorgt fuer eine Farbtransformation.
Das heißt, zu jeder Farbe der Figur werden die RGB-Werte um feste Betraege geaendert (positive oder negative). Sprengt ein entstehender Wert den Rahmen [0; 255] (zum Beispiel 160 + 100 oder 50 - 80), so bleibt der Farbwert am Rand des moeglichen Bereiches (also 0 bzw. 255).

Parameters:

r - Der Rot-Aenderungswert (positiv und negativ moeglich)

g - Der Gruen-Aenderungswert (positiv und negativ moeglich)

b - Der Blau-Aenderungswert (positiv und negativ moeglich)

See Also:

heller(), dunkler(), negativ()

einfaerben

public void einfaerben(java.lang.String farbe)

Faerbt alle Elemente in einer Farbe ein.
Dieser Zustand laesst sich zuruecksetzen mit der Methode zurueckFaerben().

Parameters:

farbe - Die Farbe, mit der alle farbenthaltenden Unterquadrate der Figur eingefaerbt werden.
Eingabe als String, so wie bei den anderen einfachen Farbeingaben auch.

See Also:

zurueckFaerben(), einfaerben(Farbe)

einfaerben

public void einfaerben(Farbe f)

Faerbt alle Elemente in einer Farbe ein.
Dieser Zustand laesst sich zuruecksetzen mit der Methode zurueckFaerben().

Parameters:

f - Die Farbe, mit der alle farbenthaltenden Unterquadrate der Figur eingefaerbt werden.

See Also:

zurueckFaerben(), einfaerben(String)

spiegelXSetzen

public void spiegelXSetzen(boolean spiegel)

Setzt, ob diese Figur bei der Darstellung waagrecht zentral gespiegelt werden soll oder nicht.
Dies aendert die Drehungsrichtung einer Figur von N nach S bzw. umgekehrt.

Parameters:

spiegel - Ist dieser Wert true, so wird die Figur waagrecht gespiegelt im Vergleich zu ihrer Quelldatei dargestellt. Durch false kann dieser Zustand schnell wieder zurueckgesetzt werden.

See Also:

spiegelYSetzen(boolean), yGespiegelt(), xGespiegelt()

spiegelYSetzen

public void spiegelYSetzen(boolean spiegel)

Setzt, ob diese Figur bei der Darstellung senkrecht zentral gespiegelt werden soll oder nicht.
So laesst sich extrem schnell z.B. Drehung einer Spielfigur von links nach rechts im Spiel realisieren.

Parameters:

spiegel - Ist dieser Wert true, so wird die Figur senkrecht gespiegelt im Vergleich zu ihrer Quelldatei dargestellt. Durch false kann dieser Zustand schnell wieder zurueckgesetzt werden.

See Also:

spiegelXSetzen(boolean), yGespiegelt(), xGespiegelt()

xGespiegelt

public boolean xGespiegelt()

Diese Methode gibt aus, ob diese Figur derzeit an der X-Achse (waagrecht) gespiegelt ist.

Returns:

Ist dieser Wert true, wird diese Figur derzeit genau an der X-Achse gespiegelt dargestellt, im Verhältnis zu der ursprünglichen Figurdatei.

See Also:

spiegelXSetzen(boolean), spiegelYSetzen(boolean), yGespiegelt()

yGespiegelt

public boolean yGespiegelt()

Diese Methode gibt aus, ob diese Figur derzeit an der Y-Achse (senkrecht) gespiegelt ist.

Returns:

Ist dieser Wert true, wird diese Figur derzeit genau an der Y-Achse gespiegelt dargestellt, im Verhältnis zu der ursprünglichen Figurdatei.

See Also:

spiegelXSetzen(boolean), spiegelYSetzen(boolean), xGespiegelt()

zurueckFaerben

public void zurueckFaerben()

Sorgt dafuer, dass nach dem Aufruf von einfaerben(Farbe) die Figur wieder ihre normalen Farbgegebenheiten kriegt.

See Also:

einfaerben(Farbe), einfaerben(String)

zeichnen

public void zeichnen(java.awt.Graphics2D g,
                     BoundingRechteck r)

Zeichnet das Objekt.

Specified by:

zeichnen in class Raum

Parameters:

g - Das zeichnende Graphics-Objekt

r - Das BoundingRechteck, dass die Kameraperspektive Repraesentiert.
Hierbei soll zunaechst getestet werden, ob das Objekt innerhalb der Kamera liegt, und erst dann gezeichnet werden.

dimension

public BoundingRechteck dimension()

Description copied from class: Raum

Methode zum Beschreiben der rechteckigen Fläche, die dieses Objekt einnimmt.
Diese Methode wird zentral für die Trefferkollisionen innerhalb der Engine benutzt und gehört zu den wichtigsten Methoden der Klasse und der Engine.

Specified by:

dimension in class Raum

Returns:

Ein BoundingRechteck mit minimal nötigem Umfang, um das Objekt voll einzuschließen.

erzeugeCollider

public Collider erzeugeCollider()

Erzeugt einen neuen Collider für dieses Objekt. Diese Methode approximiert für das Objekt der jeweils implementierenden Raum-Klasse einen möglichst "guten" Collider; also einen solchen, der das tatsächliche Objekt möglichst genau umfängt, aber auch möglichst wenig Rechenarbeit beansprucht.

Specified by:

erzeugeCollider in class Raum

Returns:

Ein möglichst optimaler Collider für dieses Raum-Objekt.

See Also:

Raum.colliderSetzen(Collider)

flaechen

public BoundingRechteck[] flaechen()

Description copied from class: Raum

Berechnet exakter alle Rechteckigen Flaechen, auf denen dieses Objekt liegt.
Diese Methode wird von komplexeren Gebilden, wie geometrischen oder Listen ueberschrieben.

Overrides:

flaechen in class Raum

Returns:

Alle Rechtecksflaechen, auf denen dieses Objekt liegt. Ist standartisiert ein Array der Groesse 1 mit der dimension() als Inhalt.

See Also:

Knoten

aktuellesBild

public int aktuellesBild()

Gibt den Index des aktuellen Bildes zurueck.
Die Figur, die im Pixelfeldeditor erstellt wurde besteht den Bildern (1, 2, ..., n), aber ACHTUNG, die Indizes fangen bei 0 an und hoeren dann eins frueher auf (0, 1, ..., (n-1)). Das heisst, dass wenn als Index 5 zurueckgegeben wird, wird zur Zeit das Bild gezeigt, das im Figureneditor als Bild 6 bezeichnet wurde.

Returns:

Der Index des aktuell angezeigten Bildes

animation

public PixelFeld[] animation()

Returns:

Alle PixelFelder der Animation.

intervall

public int intervall()

Gibt das Intervall dieser Figur zurueck.

Returns:

Das Intervall dieser Figur. Dies ist die Zeit in Millisekunden, die ein Animationsbild zu sehen bleibt

See Also:

animationsGeschwindigkeitSetzen(int)

animationsGeschwindigkeitSetzen

public void animationsGeschwindigkeitSetzen(int intervall)

Setzt die Geschwindigkeit der Animation, die diese Figur Figuren steuert.
Jed groesser Die Zahl ist, desto langsamer laeuft die Animation, da der Eingabeparamter die Wartezeit zwischen der Schaltung der Animationsbilder in Millisekunden angibt!

Parameters:

intervall - Die Wartezeit in Millisekunden zwischen den Bildaufrufen dieser Figur.