+ * Wie mit dieser Information umgegangen wird, ist nicht weiter festgelegt. + * In der Regel sollte eine aufrufende Instanz zunächst prüfen, ob das + * Objekt aktiv ist, und nur dann{@link #draw(Graphics2D)} aufrufen. Für + * implementierende Klassen ist es aber gegebenenfalls auch sinnvoll, bei + * Inaktivität den Aufruf von {@code draw(Graphics2D)} schnell abzubrechen: + *
+ * void draw( Graphics2D graphics ) {
+ * if( !isVisible() ) {
+ * return;
+ * }
+ *
+ * // Objekt zeichnen..
+ * }
+ * + * Die {@code Zeichenleinwand} besteht aus einer Reihe von Ebenen, die + * übereinandergelegt und von "unten" nach "oben" gezeichnet werden. Die Inhalte + * der oberen Ebenen können also Inhalte der darunterliegenden verdecken. + * + * Ebenen sind ein zentraler Bestandteil bei der Implementierung einer {@link Zeichenmaschine}. + * Es werden + * Sie erben von {@code Constants}, damit sie beim + */ public abstract class Layer extends Constants implements Drawable, Updatable { + /** + * Interner Puffer für die Ebene, der einmal pro Frame auf die + * Zeichenleinwand übertragen wird. + */ protected BufferedImage buffer; + /** + * Der Grafikkontext der Ebene, der zum Zeichnen der Inhalte verwendet + * wird. + */ protected Graphics2D drawing; + /** + * Ob die Ebene derzeit sichtbar ist. + */ protected boolean visible = true; + /** + * Ob die Ebene aktiv ist, also {@link #update(double) Updates} empfangen + * soll. + */ protected boolean active = true; @@ -33,6 +59,12 @@ public abstract class Layer extends Constants implements Drawable, Updatable { return buffer.getHeight(); } + /** + * Ändert die Größe der Ebene auf die angegebene Größe. + * + * @param width Die neue Breite. + * @param height Die neue Höhe. + */ public void setSize( int width, int height ) { if( buffer != null ) { if( buffer.getWidth() != width || buffer.getHeight() != height ) { @@ -44,8 +76,13 @@ public abstract class Layer extends Constants implements Drawable, Updatable { } + /** + * Gibt die Resourcen der Ebene frei. + */ public void dispose() { drawing.dispose(); + drawing = null; + buffer = null; } /** diff --git a/src/main/java/schule/ngb/zm/Updatable.java b/src/main/java/schule/ngb/zm/Updatable.java index 0998e1c..94eb76e 100644 --- a/src/main/java/schule/ngb/zm/Updatable.java +++ b/src/main/java/schule/ngb/zm/Updatable.java @@ -1,21 +1,42 @@ package schule.ngb.zm; /** - * Aktualisierbare Objekte können in regelmäßigen Intervallen (meist einmal - * pro Frame) ihren Zustand update. Diese Änderung kann abhängig vom + * {@code Updatable} Objekte können in regelmäßigen Intervallen (meist einmal + * pro Frame) ihren Zustand aktualisieren. Diese Änderung kann abhängig vom * Zeitintervall (in Sekunden) zum letzten Aufruf passieren. */ public interface Updatable { /** * Gibt an, ob das Objekt gerade auf Aktualisierungen reagiert. - * @return {@code true}, wenn das Objekt aktiv ist. + *
+ * Wie mit dieser Information umgegangen wird, ist nicht weiter festgelegt. + * In der Regel sollte eine aufrufende Instanz zunächst prüfen, ob das + * Objekt aktiv ist, und nur dann{@link #update(double)} aufrufen. Für + * implementierende Klassen ist es aber gegebenenfalls auch sinnvoll, bei + * Inaktivität den Aufruf von {@code update(double)} schnell abzubrechen: + *
+ * void update( double delta ) {
+ * if( !isActive() ) {
+ * return;
+ * }
+ *
+ * // Aktualisierung ausführen..
+ * }
+ * + * Die kann, muss aber nicht, die Rückgabe von {@link #isActive()} + * berücksichtigen. + * * @param delta Zeitintervall seit dem letzten Aufruf (in Sekunden). */ public void update( double delta );