Public API Reference

physicallayer/propclas.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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CEL_PL_PROPCLASS__
#define __CEL_PL_PROPCLASS__

#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/strset.h"
#include "csutil/ref.h"
#include "physicallayer/datatype.h"
#include "physicallayer/entity.h"
#include "physicallayer/persist.h"

struct iCelPropertyClassList;

#define CEL_QUERY_PROPCLASS(PcList,Interface)                               \
  (celQueryPropertyClass<Interface> (PcList))

#define CEL_QUERY_PROPCLASS_TAG(PcList,Interface,Tag)                       \
  (celQueryPropertyClassTag<Interface> (PcList,Tag))

#define CEL_QUERY_PROPCLASS_ENT(Ent,Interface)                              \
  (celQueryPropertyClassEntity<Interface> (Ent))

#define CEL_QUERY_PROPCLASS_TAG_ENT(Ent,Interface,Tag)                      \
  CEL_QUERY_PROPCLASS_TAG((Ent)->GetPropertyClassList(),Interface,Tag)

#define CEL_REMOVE_PROPCLASS(PcList,Interface)                              \
  ((PcList)->RemoveByInterface (scfInterfaceTraits<Interface>::GetID(),           \
                                scfInterfaceTraits<Interface>::GetVersion()))

#define CEL_REMOVE_PROPCLASS_TAG(PcList,Interface,Tag)                      \
  ((PcList)->RemoveByInterfaceAndTag (                                      \
        scfInterfaceTraits<Interface>::GetID(),                                     \
        scfInterfaceTraits<Interface>::GetVersion(), Tag))

#define CEL_REMOVE_PROPCLASS_ENT(Ent, Interface)                            \
  CEL_REMOVE_PROPCLASS((Ent)->GetPropertyClassList(),Interface)

#define CEL_REMOVE_PROPCLASS_TAG_ENT(Ent,Interface,Tag)                     \
  CEL_REMOVE_PROPCLASS_TAG((Ent)->GetPropertyClassList(),Interface,Tag)

class csVector3;
class csColor;
struct iCelEntity;
struct iCelDataBuffer;
struct iCelPropertyChangeCallback;
struct iCelParameterBlock;

struct iCelPropertyClass : public virtual iBase
{
  SCF_INTERFACE (iCelPropertyClass, 0, 0, 8);

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

  virtual const char* GetName () const = 0;

  virtual void SetTag (const char* tagname) = 0;

  virtual const char* GetTag () const = 0;

  virtual iCelEntity* GetEntity () = 0;

  virtual void SetEntity (iCelEntity* entity) = 0;

  virtual csPtr<iCelDataBuffer> SaveFirstPass () = 0;

  virtual bool LoadFirstPass (iCelDataBuffer* databuf) = 0;

  virtual csPtr<iCelDataBuffer> Save () = 0;

  virtual bool Load (iCelDataBuffer* databuf) = 0;

  virtual bool AddPropertyChangeCallback (iCelPropertyChangeCallback* cb) = 0;

  virtual bool RemovePropertyChangeCallback (
        iCelPropertyChangeCallback* cb) = 0;

  virtual bool SetProperty (csStringID propertyID, long value) = 0;

  virtual bool SetProperty (csStringID propertyID, float value) = 0;

  virtual bool SetProperty (csStringID propertyID, bool value) = 0;

  virtual bool SetProperty (csStringID propertyID, const char* value) = 0;

  virtual bool SetProperty (csStringID propertyID, const csVector2& value) = 0;

  virtual bool SetProperty (csStringID propertyID, const csVector3& value) = 0;

  virtual bool SetProperty (csStringID propertyID, const csColor& value) = 0;

  virtual bool SetProperty (csStringID propertyID,
        iCelPropertyClass* value) = 0;

  virtual bool SetProperty (csStringID propertyID, iCelEntity* entity) = 0;

  virtual bool SetProperty (csStringID propertyID, iBase* ibase) = 0;

  virtual celDataType GetPropertyOrActionType (
        csStringID propertyID) = 0;

  virtual bool IsPropertyReadOnly (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyLongByID() instead.")
  virtual long GetPropertyLong (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyFloatByID() instead.")
  virtual float GetPropertyFloat (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyBoolByID() instead.")
  virtual bool GetPropertyBool (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyStringByID() instead.")
  virtual const char* GetPropertyString (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyVectorByID() instead.")
  virtual bool GetPropertyVector (csStringID propertyID, csVector2& v) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyVectorByID() instead.")
  virtual bool GetPropertyVector (csStringID propertyID, csVector3& v) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyColorByID() instead.")
  virtual bool GetPropertyColor (csStringID propertyID, csColor& v) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyPClassByID() instead.")
  virtual iCelPropertyClass* GetPropertyPClass (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyEntityByID() instead.")
  virtual iCelEntity* GetPropertyEntity (csStringID propertyID) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetPropertyIBaseByID() instead.")
  virtual iBase* GetPropertyIBase (csStringID propertyID) = 0;

  virtual long GetPropertyLongByID (csStringID propertyID) = 0;

  virtual float GetPropertyFloatByID (csStringID propertyID) = 0;

  virtual bool GetPropertyBoolByID (csStringID propertyID) = 0;

  virtual const char* GetPropertyStringByID (csStringID propertyID) = 0;

  virtual bool GetPropertyVectorByID (csStringID propertyID, csVector2& v) = 0;

  virtual bool GetPropertyVectorByID (csStringID propertyID, csVector3& v) = 0;

  virtual bool GetPropertyColorByID (csStringID propertyID, csColor& v) = 0;

  virtual iCelPropertyClass* GetPropertyPClassByID (csStringID propertyID) = 0;

  virtual iCelEntity* GetPropertyEntityByID (csStringID propertyID) = 0;

  virtual iBase* GetPropertyIBaseByID (csStringID propertyID) = 0;

  virtual bool PerformAction (csStringID actionID,
        iCelParameterBlock* params, celData& ret) = 0;

  virtual size_t GetPropertyAndActionCount () = 0;

  virtual csStringID GetPropertyOrActionID (size_t i) = 0;

  virtual const char* GetPropertyOrActionDescription (csStringID) = 0;

  virtual void PropertyClassesHaveChanged () = 0;

  virtual csPtr<iCelDataBuffer> GetPersistentData (
        celPersistenceType persistence_type) = 0;

  virtual celPersistenceResult SetPersistentData (csTicks data_time, 
        iCelDataBuffer* data, celPersistenceType persistence_type) = 0;
};


struct iCelPropertyClassList : public virtual iBase
{
  SCF_INTERFACE (iCelPropertyClassList, 0, 0, 2);

  virtual size_t GetCount () const = 0;

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

  virtual size_t Add (iCelPropertyClass* obj) = 0;

  virtual bool Remove (iCelPropertyClass* obj) = 0;

  virtual bool Remove (size_t n) = 0;

  virtual bool RemoveByInterface (scfInterfaceID scf_id, int iVersion) = 0;

  virtual bool RemoveByInterfaceAndTag (scfInterfaceID scf_id,
        int iVersion, const char* tag) = 0;

  virtual void RemoveAll () = 0;

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

  virtual iCelPropertyClass* FindByName (const char *name) const = 0;

  virtual iCelPropertyClass* FindByNameAndTag (const char *name,
        const char* tag) const = 0;

  virtual iBase* FindByInterface (
        scfInterfaceID id, int version) const = 0;

  virtual iBase* FindByInterfaceAndTag (
        scfInterfaceID id, int version, const char* tag) const = 0;
};

template<class Interface>
inline csPtr<Interface> celQueryPropertyClassTag (
  iCelPropertyClassList* plist, const char* tag)
{
  iBase* base = plist->FindByInterfaceAndTag (
    scfInterfaceTraits<Interface>::GetID (),
    scfInterfaceTraits<Interface>::GetVersion (),
    tag);

  if (base == 0) return csPtr<Interface> (0); 

  Interface* x = (Interface*)base->QueryInterface (
    scfInterfaceTraits<Interface>::GetID (),
    scfInterfaceTraits<Interface>::GetVersion ());

  base->DecRef ();      // Release our base interface.
  return csPtr<Interface> (x);
}

template<class Interface>
inline csPtr<Interface> celQueryPropertyClass (
  iCelPropertyClassList* plist)
{
  iBase* base = plist->FindByInterface (
    scfInterfaceTraits<Interface>::GetID (),
    scfInterfaceTraits<Interface>::GetVersion ());

  if (base == 0) return csPtr<Interface> (0); 

  Interface* x = (Interface*)base->QueryInterface (
    scfInterfaceTraits<Interface>::GetID (),
    scfInterfaceTraits<Interface>::GetVersion ());

  base->DecRef ();      // Release our base interface.
  return csPtr<Interface> (x);
}

template<class Interface>
inline csPtr<Interface> celQueryPropertyClassEntity (
  iCelEntity* entity)
{
  return celQueryPropertyClass<Interface> (entity->GetPropertyClassList ());
}

#endif // __CEL_PL_PROPCLASS__

---