src/se/umu/cs/dit06ajnajs/level/MapSquare.java

   1 package se.umu.cs.dit06ajnajs.level;
   2
   3 import java.awt.Graphics;
   4 import java.awt.Image;
   5 import java.awt.Point;
   6 import java.util.Observable;
   7
   8 import se.umu.cs.dit06ajnajs.Clickable;
   9 import se.umu.cs.dit06ajnajs.Paintable;
  10 import se.umu.cs.dit06ajnajs.AntiTD;
  11 import java.awt.Rectangle;
  12
  13 /**
  14  * Abstract class MapSquare represents a square with a graphical representation
  15  * and a position.
  16  *
  17  * @author dit06ajs
  18  * @author dit06ajn
  19  * @version 1.0
  20  */
  21 public abstract class MapSquare extends Observable implements Paintable,
  22                                                               Cloneable,
  23                                                               Clickable {
  24     private int x;
  25     private int y;
  26     private int centerX;
  27     private int centerY;
  28
  29     private Image image;
  30
  31     /**
  32      * Creates new instans with position and image
  33      * @param x the x coordinate of the square
  34      * @param y the y coordinate of the square
  35      * @param image the image of the square
  36      */
  37     public MapSquare(int x, int y, Image image) {
  38         setX(x);
  39         setY(y);
  40         this.image = image;
  41     }
  42
  43     /**
  44      * Used to initialize fields that should be individually set for every
  45      * MapSquare, since clone() is shallow.
  46      *
  47      * Empty method, ovveridden by subclass to implement behaviour.
  48      */
  49     public void init() {
  50
  51     }
  52
  53     /**
  54      * Paints this MapSquares Image to the specified Grahics object.
  55      *
  56      * @param g The Graphics to paint to.
  57      */
  58     public void paint(Graphics g) {
  59         g.drawImage(image, x, y, null);
  60     }
  61
  62     /**
  63      * Returns the Images used by this MapSquare.
  64      *
  65      * @return The Images used by this MapSquare.
  66      */
  67     public Image getImage() {
  68         return this.image;
  69     }
  70
  71     /**
  72      * Returns the top left point of this MapSquare.
  73      *
  74      * @return The top left point of this MapSquare.
  75      */
  76     public Point getPosition() {
  77         Point p = new Point(x, y);
  78         return p;
  79     }
  80
  81     /**
  82      * Returns the center position of this MapSquare.
  83      *
  84      * @return The center position of this MapSquare.
  85      */
  86     public Point getCenterPoint() {
  87         return new Point(this.centerX, this.centerY);
  88     }
  89
  90     /**
  91      * Returns the center x position of this MapSquare.
  92      *
  93      * @return The center x position of this MapSquare.
  94      */
  95     public int getCenterX() {
  96         return this.centerX;
  97     }
  98
  99     /**
 100      * Returns the center y position of this MapSquare.
 101      *
 102      * @return The center y position of this MapSquare.
 103      */
 104     public int getCenterY() {
 105         return this.centerY;
 106     }
 107
 108     /**
 109      * Returns the x position of this MapSquare.
 110      *
 111      * @return The x position of this MapSquare.
 112      */
 113     public int getX() {
 114         return x;
 115     }
 116
 117     /**
 118      * Sets the x position and recalculates center x position of this MapSquare.
 119      *
 120      * @param x The new x center position.
 121      */
 122     public void setX(int x) {
 123         this.x = x;
 124         this.centerX = this.x + (int) Math.round(AntiTD.SQUARE_SIZE/2.0);
 125     }
 126
 127     /**
 128      * Returns the center y position of this MapSquare.
 129      *
 130      * @return The center y position of this MapSquare.
 131      */
 132     public int getY() {
 133         return y;
 134     }
 135
 136     /**
 137      * Sets the y position and recalculates center x position of this MapSquare.
 138      *
 139      * @param y The new y center position.
 140      */
 141     public void setY(int y) {
 142         this.y = y;
 143         this.centerY = this.y + (int) Math.round(AntiTD.SQUARE_SIZE/2.0);
 144     }
 145
 146     /**
 147      * Sets the Image of this MapSquare.
 148      *
 149      * @param img The Image of this MapSquare.
 150      */
 151     public void setImage(Image img) {
 152         image = img;
 153     }
 154
 155     /**
 156      * Empty method, ovveridden by subclass to implement behaviour when a user
 157      * clicks this MapSquare.
 158      */
 159     public void click() {
 160     }
 161
 162     /**
 163      * Checks if the specified x and y position is inside of bounds.
 164      *
 165      * @param x The x-value to check.
 166      * @param y The y-value to check.
 167      * @return If the specified x and y position is inside of bounds.
 168      */
 169     public boolean contains(int x, int y) {
 170         return new Rectangle(this.x, this.y,
 171                              AntiTD.SQUARE_SIZE, AntiTD.SQUARE_SIZE).contains(x, y);
 172     }
 173
 174     /**
 175      * Attemts to clone this MapSquare.
 176      *
 177      * @return A new instance of the same type as the instantiated MapSquare.
 178      */
 179     @Override
 180     public Object clone() {
 181         try {
 182             return super.clone();
 183         } catch (CloneNotSupportedException e) {
 184             e.printStackTrace();
 185             throw new Error("Object " + this.getClass().getName()
 186                     + " is not Cloneable");
 187         }
 188     }
 189
 190     @Override
 191     public String toString() {
 192         return "MapSquare: " + this.getClass().getName()
 193         + " @("+ x +", " + y +")";
 194     }
 195 }