src/org/sourceforge/desert/ParticleDefaultImplementation.java

   1 /*
   2  * Copyright (c) 2010 The Desert team
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use,
   8  * copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following
  11  * conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  18  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  20  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  21  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  *
  25  */
  26 package org.sourceforge.desert;
  27
  28 /**
  29  *
  30  * @author codistmonk (creation 2010-04-17)
  31  */
  32 public class ParticleDefaultImplementation implements Particle {
  33
  34     private Type type;
  35
  36     private float x;
  37
  38     private float y;
  39
  40     private float speedX;
  41
  42     private float speedY;
  43
  44     public ParticleDefaultImplementation() {
  45         this(Type.values()[0], 0F, 0F, 0F, 0F);
  46     }
  47
  48     /**
  49      *
  50      * @param type
  51      * <br>Should not be null
  52      * @param x
  53      * <br>Should not be null
  54      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
  55      * @param y
  56      * <br>Should not be null
  57      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
  58      * @param speedX
  59      * <br>Should not be null
  60      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
  61      * @param speedY
  62      * <br>Should not be null
  63      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
  64      */
  65     public ParticleDefaultImplementation(final Type type, final float x, final float y, final float speedX, final float speedY) {
  66         this.type = type;
  67         this.x = x;
  68         this.y = y;
  69         this.speedX = speedX;
  70         this.speedY = speedY;
  71     }
  72
  73     @Override
  74     public final float getSpeedX() {
  75         return speedX;
  76     }
  77
  78     /**
  79      *
  80      * @param speedX
  81      * <br>Should not be null
  82      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
  83      */
  84     public final void setSpeedX(final float speedX) {
  85         this.speedX = speedX;
  86     }
  87
  88     @Override
  89     public final float getSpeedY() {
  90         return this.speedY;
  91     }
  92
  93     /**
  94      *
  95      * @param speedY
  96      * <br>Should not be null
  97      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
  98      */
  99     public final void setSpeedY(final float speedY) {
 100         this.speedY = speedY;
 101     }
 102
 103     @Override
 104     public final Type getType() {
 105         return this.type;
 106     }
 107
 108     /**
 109      *
 110      * @param type
 111      * <br>Should not be null
 112      */
 113     public final void setType(final Type type) {
 114         this.type = type;
 115     }
 116
 117     @Override
 118     public final float getX() {
 119         return this.x;
 120     }
 121
 122     /**
 123      *
 124      * @param x
 125      * <br>Should not be null
 126      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
 127      */
 128     public final void setX(final float x) {
 129         this.x = x;
 130     }
 131
 132     @Override
 133     public final float getY() {
 134         return this.y;
 135     }
 136
 137     /**
 138      *
 139      * @param y
 140      * <br>Should not be null
 141      * <br>Range: <code>]float.NEGATIVE_INFINITY .. float.POSITIVE_INFINITY[</code>
 142      */
 143     public final void setY(final float y) {
 144         this.y = y;
 145     }
 146
 147     @Override
 148     public String toString() {
 149         return "(" + this.getType() + ", " + this.getX() + ", " + this.getY() + ", " + this.getSpeedX() + ", " + this.getSpeedY() + ")";
 150     }
 151
 152     @Override
 153     public final boolean equals(final Object obj) {
 154         if (obj == null) {
 155             return false;
 156         }
 157         if (!Particle.class.isAssignableFrom(obj.getClass())) {
 158             return false;
 159         }
 160         final Particle other = (Particle) obj;
 161         if (this.getType() != other.getType() && (this.getType() == null || !this.getType().equals(other.getType()))) {
 162             return false;
 163         }
 164         if (this.getX() != other.getX()) {
 165             return false;
 166         }
 167         if (this.getY() != other.getY()) {
 168             return false;
 169         }
 170         if (this.getSpeedX() != other.getSpeedX()) {
 171             return false;
 172         }
 173         if (this.getSpeedY() != other.getSpeedY()) {
 174             return false;
 175         }
 176         return true;
 177     }
 178
 179     @Override
 180     public final int hashCode() {
 181         int hash = 3;
 182
 183         hash = 47 * hash + (this.type != null ? this.type.hashCode() : 0);
 184
 185         return hash;
 186     }
 187
 188 }