---

agent.h

Go to the documentation of this file.

/*
  svas_server -- virtual World Server of Svas
  Copyright (c) 2001, 2002 David Moreno Montero
 
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
 
  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.  

*/

#ifndef __AGENT_H__
#define __AGENT_H__

#include <thread.h>
#include "cylinder.h"
#include "vector3d.h"
#include <vector>
#include "boundingbox.h"

class Client;
class World;

/**
 * The agents are the organisms of this world. They are composed of
 * cylinders; It have a maximum of 256 cylinders (as array for speed).
 * One cylinder is created at constructor time.
 */
class Agent{
 protected:
  /** Max id reached by agents. Each new agent need to have a brand
   * new id */ 
  static unsigned long int agentMaxId;
  /// The id of the actual agent 
  unsigned long int id;

  /** The parent cylinder in the agent, all the rest cylinder hangs from it */
  Cylinder *cylinder;
  /** The client to which the agent belongs */
  Client *client;
  /** 
   * The count of cylinders, if a new cylinder is created in this
   * agent this number increases, and the old number is returned.
   */
  short int cylinderCount;
 public:
  /// Creates an empty agent. The Client pointer is the agent owner
  Agent(Client *, const Point3d &position, const char *creationMessage, unsigned long int messageSize);
  /// Creates an agent based on a cylinder and it's old-agent properties
  Agent(Client *, Cylinder *, const char *creationMessage, unsigned long int messageSize);
  /// Destroy the client
  ~Agent();

  /**
   * @name some gets
   * some properties that can be consulted 
   * @{
   */
  unsigned long int getId(void){ return id; };
  Client *getClient(){ return client; };
  /// Returns (and maybe generate) a new cylinder id
  short int getCylinderCount(bool increment=false){ if (increment){ cylinderCount++;  return cylinderCount-1; } return cylinderCount; };
  inline short int getNumCylinders(void){ return cylinder->getNumCylinders(); }
  /// Get the specified cylinder. By number (see numCylinders())
  Cylinder *operator()(unsigned short int i){ return (*cylinder)(i); };
  /// Get specified cylinder by id
  Cylinder *operator[](unsigned short int i){ return (*cylinder)[i]; };
  World *getWorld();
  /** @}  */

  /// Receives a message from another agent
  void receiveMessage(unsigned long int _agentId, const char *message, unsigned long int size);

  /// Checks if the agent is in the bounding box
  inline bool into(BoundingBox &bbox){ return bbox.contains(cylinder->getPosition()); };

  /// Performs desired intentions, as each cylinder can have only one.
  vector<Cylinder *> performActions();
};

#endif

---