Public API Reference

iengine/engine.h

Go to the documentation of this file.

/*
    Crystal Space 3D Engine
    Copyright (C) 1998-2002 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 __CS_IENGINE_ENGINE_H__
#define __CS_IENGINE_ENGINE_H__

#include "csutil/scf_interface.h"

#include "csgeom/vector3.h"

#include "iengine/light.h"

class csBox3;
class csColor;
class csFrustum;

struct iCacheManager;
struct iCamera;
struct iCameraPosition;
struct iCameraPositionList;
struct iClipper2D;
struct iCollection;
struct iCollectionList;
struct iDataBuffer;
struct iFrustumView;
struct iLight;
struct iLightIterator;
struct iLoaderContext;
struct iMaterial;
struct iMaterialList;
struct iMaterialWrapper;
struct iMeshFactoryList;
struct iMeshFactoryWrapper;
struct iMeshList;
struct iMeshObject;
struct iMeshObjectFactory;
struct iMeshObjectType;
struct iMeshWrapper;
struct iMeshWrapperIterator;
struct iObject;
struct iObjectIterator;
struct iObjectWatcher;
struct iPortal;
struct iProgressMeter;
struct iRegion;
struct iRegionList;
struct iRenderLoop;
struct iRenderLoopManager;
struct iRenderView;
struct iSector;
struct iSectorIterator;
struct iSectorList;
struct iSharedVariableList;
struct iTextureHandle;
struct iTextureList;
struct iTextureWrapper;

struct iEngine;

#define CS_ENGINE_CACHE_READ 1

#define CS_ENGINE_CACHE_WRITE 2

#define CS_ENGINE_CACHE_NOUPDATE 4

enum csRenderPrioritySorting
{
  CS_RENDPRI_SORT_NONE = 0,

  CS_RENDPRI_SORT_BACK2FRONT = 1,

  CS_RENDPRI_SORT_FRONT2BACK = 2
};
struct iEngineFrameCallback : public virtual iBase
{
  SCF_INTERFACE(iEngineFrameCallback,1,0,0);
  virtual void StartFrame (iEngine* engine, iRenderView* rview) = 0;
};

struct iEngineSectorCallback : public virtual iBase
{
  SCF_INTERFACE(iEngineSectorCallback,2,0,0);
  virtual void NewSector (iEngine* engine, iSector* sector) = 0;

  virtual void RemoveSector (iEngine* engine, iSector* sector) = 0;
};


struct iEngine : public virtual iBase
{
  SCF_INTERFACE(iEngine,2,0,0);
  
  virtual iObject *QueryObject() = 0;

  virtual bool Prepare (iProgressMeter* meter = 0) = 0;

  virtual void PrepareTextures () = 0;

  virtual void PrepareMeshes () = 0;

  virtual void ForceRelight (iRegion* region = 0,
        iProgressMeter* meter = 0) = 0;

  virtual void ForceRelight (iLight* light, iRegion* region = 0) = 0;

  virtual void ShineLights (iRegion* region = 0,
        iProgressMeter* meter = 0) = 0;

  virtual void SetLightingCacheMode (int mode) = 0;

  virtual int GetLightingCacheMode () = 0;

  virtual void SetCacheManager (iCacheManager* cache_mgr) = 0;

  virtual void SetVFSCacheManager (const char* vfspath = 0) = 0;

  virtual iCacheManager* GetCacheManager () = 0;

  virtual void SetMaxLightmapSize (int w, int h) = 0;

  virtual void GetMaxLightmapSize (int& w, int& h) = 0;

  virtual void GetDefaultMaxLightmapSize (int& w, int& h) = 0;

  virtual int GetMaxLightmapAspectRatio () const = 0;
  
  virtual void RegisterRenderPriority (const char* name, long priority,
        csRenderPrioritySorting rendsort = CS_RENDPRI_SORT_NONE) = 0;

  virtual long GetRenderPriority (const char* name) const = 0;
  virtual csRenderPrioritySorting GetRenderPrioritySorting (
        const char* name) const = 0;
  virtual csRenderPrioritySorting GetRenderPrioritySorting (
        long priority) const = 0;
  virtual long GetSkyRenderPriority () = 0;
  virtual long GetPortalRenderPriority () = 0;
  virtual long GetWallRenderPriority () = 0;
  virtual long GetObjectRenderPriority () = 0;
  virtual long GetAlphaRenderPriority () = 0;
  virtual void ClearRenderPriorities () = 0;
  virtual int GetRenderPriorityCount () const = 0;
  virtual const char* GetRenderPriorityName (long priority) const = 0;

  virtual csPtr<iMaterial> CreateBaseMaterial (iTextureWrapper* txt) = 0;

  virtual iMaterialWrapper* CreateMaterial (const char *name,
        iTextureWrapper* texture) = 0;

  virtual iMaterialList* GetMaterialList () const = 0;

  virtual iMaterialWrapper* FindMaterial (const char* name,
        iRegion* region = 0) = 0;

  virtual iTextureWrapper* CreateTexture (const char *name,
        const char *fileName, csColor *transp, int flags) = 0;

  virtual iTextureWrapper* CreateBlackTexture (const char *name,
        int w, int h, csColor *transp, int flags) = 0;

  virtual int GetTextureFormat () const = 0;

  virtual iTextureList* GetTextureList () const = 0;

  virtual iTextureWrapper* FindTexture (const char* name,
        iRegion* region = 0) = 0;

  virtual csPtr<iLight> CreateLight (const char* name, const csVector3& pos,
        float radius, const csColor& color,
        csLightDynamicType dyntype = CS_LIGHT_DYNAMICTYPE_STATIC) = 0;

  virtual iLight* FindLight (const char *Name, bool RegionOnly = false)
    const = 0;

  virtual iLight* FindLightID (const char* light_id) const = 0;

  virtual csPtr<iLightIterator> GetLightIterator (iRegion* region = 0) = 0;

  virtual void RemoveLight (iLight* light) = 0;

  virtual void SetAmbientLight (const csColor &) = 0;
  virtual void GetAmbientLight (csColor &) const = 0;
  virtual void GetDefaultAmbientLight (csColor &c) const = 0;

  virtual int GetNearbyLights (iSector* sector, const csVector3& pos,
        iLight** lights, int max_num_lights) = 0;

  virtual int GetNearbyLights (iSector* sector, const csBox3& box,
        iLight** lights, int max_num_lights) = 0;

  virtual iSector *CreateSector (const char *name) = 0;

  virtual iSectorList* GetSectors () = 0;

  virtual iSector* FindSector (const char* name,
        iRegion* region = 0) = 0;

  virtual csPtr<iSectorIterator> GetNearbySectors (iSector* sector,
        const csVector3& pos, float radius) = 0;

  virtual csPtr<iSectorIterator> GetNearbySectors (iSector* sector,
        const csBox3& box) = 0;

  virtual void AddEngineFrameCallback (iEngineFrameCallback* cb) = 0;

  virtual void RemoveEngineFrameCallback (iEngineFrameCallback* cb) = 0;

  virtual void AddEngineSectorCallback (iEngineSectorCallback* cb) = 0;

  virtual void RemoveEngineSectorCallback (iEngineSectorCallback* cb) = 0;

  virtual csPtr<iMeshWrapper> CreateMeshWrapper (iMeshFactoryWrapper* factory,
        const char* name, iSector* sector = 0,
        const csVector3& pos = csVector3 (0, 0, 0)) = 0;

  virtual csPtr<iMeshWrapper> CreateMeshWrapper (iMeshObject* meshobj,
        const char* name, iSector* sector = 0,
        const csVector3& pos = csVector3 (0, 0, 0)) = 0;

  virtual csPtr<iMeshWrapper> CreateMeshWrapper (const char* classid,
        const char* name, iSector* sector = 0,
        const csVector3& pos = csVector3 (0, 0, 0)) = 0;

  virtual csPtr<iMeshWrapper> CreateMeshWrapper (const char* name) = 0;

  virtual csPtr<iMeshWrapper> CreateSectorWallsMesh (iSector* sector,
      const char* name) = 0;

  virtual csPtr<iMeshWrapper> CreateThingMesh (iSector* sector,
        const char* name) = 0;

  virtual csPtr<iMeshWrapper> LoadMeshWrapper (
        const char* name, const char* loaderClassId,
        iDataBuffer* input, iSector* sector, const csVector3& pos) = 0;

  virtual void AddMeshAndChildren (iMeshWrapper* mesh) = 0;

  virtual csPtr<iMeshWrapperIterator> GetNearbyMeshes (iSector* sector,
    const csVector3& pos, float radius, bool crossPortals = true) = 0;

  virtual csPtr<iMeshWrapperIterator> GetNearbyMeshes (iSector* sector,
    const csBox3& box, bool crossPortals = true) = 0;

  virtual csPtr<iMeshWrapperIterator> GetNearbyMeshes (iSector* sector,
    const csVector3& start, const csVector3& end,
    bool crossPortals = true) = 0;

  virtual iMeshList* GetMeshes () = 0;

  virtual iMeshWrapper* FindMeshObject (const char* name,
        iRegion* region = 0) = 0;

  virtual void WantToDie (iMeshWrapper* mesh) = 0;

  virtual csPtr<iMeshFactoryWrapper> CreateMeshFactory (const char* classId,
        const char* name) = 0;

  virtual csPtr<iMeshFactoryWrapper> CreateMeshFactory (
        iMeshObjectFactory * factory, const char* name) = 0;

  virtual csPtr<iMeshFactoryWrapper> CreateMeshFactory (const char* name) = 0;

  virtual csPtr<iMeshFactoryWrapper> LoadMeshFactory (
        const char* name, const char* loaderClassId,
        iDataBuffer* input) = 0;

  virtual iMeshFactoryWrapper* FindMeshFactory (const char* name,
        iRegion* region = 0) = 0;

  virtual iMeshFactoryList* GetMeshFactories () = 0;

  virtual iRegion* CreateRegion (const char* name) = 0;
  virtual iRegionList* GetRegions () = 0;

  virtual csPtr<iCamera> CreateCamera () = 0;

  virtual iCameraPosition* FindCameraPosition (const char* name,
        iRegion* region = 0) = 0;

  virtual iCameraPositionList* GetCameraPositions () = 0;

  virtual csPtr<iMeshWrapper> CreatePortal (
        const char* name,
        iMeshWrapper* parentMesh, iSector* destSector,
        csVector3* vertices, int num_vertices,
        iPortal*& portal) = 0;

  virtual csPtr<iMeshWrapper> CreatePortal (
        const char* name,
        iSector* sourceSector, const csVector3& pos,
        iSector* destSector,
        csVector3* vertices, int num_vertices,
        iPortal*& portal) = 0;

  virtual csPtr<iMeshWrapper> CreatePortalContainer (const char* name,
        iSector* sector = 0, const csVector3& pos = csVector3 (0, 0, 0)) = 0;

  virtual void SetClearZBuf (bool yesno) = 0;

  virtual bool GetClearZBuf () const = 0;

  virtual bool GetDefaultClearZBuf () const = 0;

  virtual void SetClearScreen (bool yesno) = 0;

  virtual bool GetClearScreen () const = 0;

  virtual bool GetDefaultClearScreen () const = 0;

  virtual int GetBeginDrawFlags () const = 0;

  virtual iRenderView* GetTopLevelClipper () const = 0;

  virtual void PrecacheDraw (iRegion* region = 0) = 0;

  virtual void Draw (iCamera* c, iClipper2D* clipper,
      iMeshWrapper* mesh = 0) = 0;

  virtual void SetContext (iTextureHandle* ctxt) = 0;
  virtual iTextureHandle *GetContext () const = 0;

  virtual iRenderLoopManager* GetRenderLoopManager () = 0;
  
  virtual iRenderLoop* GetCurrentDefaultRenderloop () = 0;

  virtual bool SetCurrentDefaultRenderloop (iRenderLoop* loop) = 0;

  virtual uint GetCurrentFrameNumber () const = 0;

  virtual void SetSaveableFlag (bool enable) = 0;

  virtual bool GetSaveableFlag () = 0;

  virtual csPtr<iLoaderContext> CreateLoaderContext (
        iRegion* region = 0, bool curRegOnly = true) = 0;

  virtual csPtr<iObjectIterator> GetNearbyObjects (iSector* sector,
    const csVector3& pos, float radius, bool crossPortals = true ) = 0;

  

  virtual csPtr<iObjectIterator> GetVisibleObjects (iSector* sector,
    const csVector3& pos) = 0;

  virtual csPtr<iMeshWrapperIterator> GetVisibleMeshes (iSector* sector,
    const csVector3& pos) = 0;

  virtual csPtr<iObjectIterator> GetVisibleObjects (iSector* sector,
    const csFrustum& frustum) = 0;

  virtual csPtr<iMeshWrapperIterator> GetVisibleMeshes (iSector* sector,
    const csFrustum& frustum) = 0;

  virtual csPtr<iFrustumView> CreateFrustumView () = 0;

  virtual csPtr<iObjectWatcher> CreateObjectWatcher () = 0;

  virtual iSharedVariableList* GetVariableList () const = 0;

#include "csutil/win32/msvc_deprecated_warn_off.h"
  CS_DEPRECATED_METHOD_MSG("Collections are obsolete")
  virtual iCollectionList* GetCollections () = 0;
  
  CS_DEPRECATED_METHOD_MSG("Collections are obsolete")
  virtual iCollection* FindCollection (const char* name,
        iRegion* region = 0) = 0;
#include "csutil/win32/msvc_deprecated_warn_on.h"

  virtual bool RemoveObject (iBase* object) = 0;

  virtual void DelayedRemoveObject (csTicks delay, iBase* object) = 0;

  virtual void RemoveDelayedRemoves (bool remove = false) = 0;
 
  virtual void DeleteAll () = 0;

  virtual void ResetWorldSpecificSettings() = 0;  
  
};

#endif // __CS_IENGINE_ENGINE_H__

---