src/appletbots/WorldObject.java

   1 /*
   2  * Copyright (c) 2002 Erik Rasmussen - All Rights Reserverd
   3  */
   4 package appletbots;
   5
   6 import java.awt.*;
   7
   8 /**
   9  * This is an abstract class representing an object in the world
  10  *
  11  * @author Erik Rasmussen
  12  */
  13 public abstract class WorldObject
  14 {
  15         /**
  16          * The object's mass
  17          */
  18         protected double mass;
  19         /**
  20          * The object's maximum speed
  21          */
  22         protected double maxSpeed;
  23         /**
  24          * The object's radius
  25          */
  26         protected int size;
  27         /**
  28          * The object's color
  29          */
  30         protected Color color;
  31
  32         /**
  33          * Creates a new WorldObject with the given parameters
  34          *
  35          * @param mass     The object's mass
  36          * @param maxSpeed The object's maximum speed
  37          * @param size     The object's radius
  38          * @param color    The object's color
  39          */
  40         public WorldObject(final double mass, final double maxSpeed, final int size, final Color color)
  41         {
  42                 this.mass = mass;
  43                 this.maxSpeed = maxSpeed;
  44                 this.size = size;
  45                 this.color = color;
  46         }
  47
  48         /**
  49          * Returns the object's mass
  50          *
  51          * @return The object's mass
  52          */
  53         public final double getMass()
  54         {
  55                 return mass;
  56         }
  57
  58         /**
  59          * Returns the object's maximum speed
  60          *
  61          * @return The object's maximum speed
  62          */
  63         public final double getMaxSpeed()
  64         {
  65                 return maxSpeed;
  66         }
  67
  68         /**
  69          * Returns the object's radius
  70          *
  71          * @return The object's radius
  72          */
  73         public final int getSize()
  74         {
  75                 return size;
  76         }
  77
  78         /**
  79          * Returns the object's color
  80          *
  81          * @return The object's color
  82          */
  83         public final Color getColor()
  84         {
  85                 return color;
  86         }
  87
  88         /**
  89          * Informs the object that it has been in a collision
  90          *
  91          * @param object The object collided with
  92          */
  93         public void collidedWith(final WorldObject object)
  94         {
  95         }
  96 }