src/appletbots/CarriableObject.java

   1 /*
   2  * Copyright (c) 2002 Erik Rasmussen - All Rights Reserved
   3  */
   4 package appletbots;
   5
   6 import java.awt.*;
   7
   8 /**
   9  * This class represents an object that can be picked up in the appletbots
  10  * world.
  11  *
  12  * @author Erik Rasmussen
  13  */
  14 public abstract class CarriableObject extends WorldObject
  15 {
  16         /**
  17          * The agent carrying the object
  18          */
  19         private CarrierAgent carriedBy;
  20
  21         /**
  22          * Creates a new CarriableObject with the given parameters
  23          *
  24          * @param mass     The object's mass
  25          * @param maxSpeed The object's maximum speed
  26          * @param size     The object's radius
  27          * @param color    The object's color
  28          */
  29         public CarriableObject(final double mass, final double maxSpeed, final int size, final Color color)
  30         {
  31                 super(mass, maxSpeed, size, color);
  32         }
  33
  34         /**
  35          * Returns whether or not the object is being carried
  36          *
  37          * @return Whether or not the object is being carried
  38          */
  39         public boolean isCarried()
  40         {
  41                 return carriedBy != null;
  42         }
  43
  44         /**
  45          * Informs the object about who is carrying it
  46          *
  47          * @param carriedBy The agent carrying the object
  48          */
  49         public void setCarriedBy(final CarrierAgent carriedBy)
  50         {
  51                 this.carriedBy = carriedBy;
  52         }
  53
  54         /**
  55          * Returns the agent carrying the object
  56          *
  57          * @return The agent carrying the object
  58          */
  59         public CarrierAgent getCarriedBy()
  60         {
  61                 return carriedBy;
  62         }
  63 }