Public API Reference

physicallayer/entity.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2001 by Jorrit Tyberghein
  
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library 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
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_PL_ENTITY__
#define __CEL_PL_ENTITY__

#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/set.h"
#include "csutil/strset.h"

struct iCelPropertyClassList;
struct iCelBehaviour;
struct iCelEntityIterator;
struct iObject;

SCF_VERSION (iCelEntity, 0, 0, 1);

struct iCelEntity : public iBase
{
  virtual iObject* QueryObject () = 0;

  virtual const char* GetName () const = 0;

  virtual void SetName (const char* n) = 0;

  virtual uint GetID () const = 0;

  virtual void SetID (uint n) = 0;

  virtual iCelPropertyClassList* GetPropertyClassList () = 0;

  virtual void SetBehaviour (iCelBehaviour* behaviour) = 0;

  virtual iCelBehaviour* GetBehaviour () = 0;

  virtual void AddClass (csStringID cls) = 0;

  virtual void RemoveClass (csStringID cls) = 0;

  virtual bool HasClass (csStringID cls) = 0;

  virtual const csSet<csStringID>& GetClasses () const = 0;
};

SCF_VERSION (iCelEntityList, 0, 0, 2);

struct iCelEntityList : public iBase
{
  virtual size_t GetCount () const = 0;

  virtual iCelEntity* Get (size_t n) const = 0;

  virtual size_t Add (iCelEntity* obj) = 0;

  virtual bool Remove (iCelEntity* obj) = 0;

  virtual bool Remove (size_t n) = 0;

  virtual void RemoveAll () = 0;

  virtual size_t Find (iCelEntity* obj) const = 0;

  virtual iCelEntity* FindByName (const char *Name) const = 0;

  virtual csPtr<iCelEntityIterator> GetIterator () const = 0;
};

struct iCelEntityIterator : public virtual iBase
{
  SCF_INTERFACE (iCelEntityIterator, 0, 0, 1);

  virtual iCelEntity* Next () = 0;

  virtual bool HasNext () const = 0;
};

#endif // __CEL_PL_ENTITY__

---