/*
 * PVVMUD a 3D MUD
 * Copyright (C) 1998-1999  Programvareverkstedet (pvv@pvv.org)
 *
 * 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 _WORLDHIERARCHY_H
#define _WORLDHIERARCHY_H

#include "objectlist.H"
#include "listener.H"

class CWorldWorld;
class CWorldObject;

class CWorldHierarchy : public CObjectList {
  friend class CWACreateObject;
  friend class CWARemoveObject;
  friend class CWAUpdateHierarchy;

  //////////////////////////////////////////////////////
  // Uniq identifyer for every object in the world system.
  // World have id -1;

  DWORD m_objectId;

  //////////////////////////////////////////////////////
  // Hierarchical atributes

  CWorldHierarchy * m_parent;

public:

  //////////////////////////////////////////////////////
  // Constructor and destructor 
  CWorldHierarchy(DWORD objectId, CWorldHierarchy * parent);
  virtual ~CWorldHierarchy();

  //////////////////////////////////////////////////////
  // Attribute access function

  DWORD getObjectId();

  CWorldHierarchy * getParent();
  DWORD getParentId();

  //////////////////////////////////////////////////////
  // Listener functions  

  virtual CListener * getListener() = 0;

  //////////////////////////////////////////////////////
  // Hierarchical functions  

  virtual CWorldWorld * getWorld();

private:
  // This function actualy do the work

  void _addObject(CWorldObject * object);
  void _removeObject(CWorldObject * object);
  void _setParent(CWorldHierarchy * parent);

public:
  // Used as virtual redirect function for animation system.

  virtual void addObject(CWorldObject * object);
  virtual void removeObject(CWorldObject * object);
  virtual void setParent(CWorldObject * parent);

  // Find a object
  CWorldObject * getObject( DWORD objectId );
  CWorldObject * getObject( char * name );

};

#endif // _WORLDHIERARCHY_H