Public API Reference

imap/loader.h

Go to the documentation of this file.

/*
    The Crystal Space geometry loader interface
    Copyright (C) 2000 by Andrew Zabolotny <[email protected]>

    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_IMAP_PARSER_H__
#define __CS_IMAP_PARSER_H__

#include "csutil/scf_interface.h"

#include "igraphic/image.h"
#include "ivideo/txtmgr.h"
#include "imap/streamsource.h"

struct iDocumentNode;
struct iImage;
struct iLight;
struct iMaterialWrapper;
struct iMeshWrapper;
struct iMeshFactoryWrapper;
struct iRegion;
struct iSector;
struct iShader;
struct iTextureHandle;
struct iTextureManager;
struct iTextureWrapper;
struct iSndSysData;
struct iSndSysWrapper;
struct iSndSysStream;

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

  virtual bool IsReady () = 0;
  virtual bool IsError () = 0;
};

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

  virtual iMaterialWrapper* MissingMaterial (const char* name,
        const char* filename) = 0;

  virtual iTextureWrapper* MissingTexture (const char* name,
      const char* filename) = 0;

  virtual iShader* MissingShader (const char* name) = 0;

  virtual iMeshFactoryWrapper* MissingFactory (const char* name) = 0;

  virtual iMeshWrapper* MissingMesh (const char* name) = 0;

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

  virtual iLight* MissingLight (const char* name) = 0;
};

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

  virtual csPtr<iImage> LoadImage (const char* Filename,
    int Format = CS_IMGFMT_INVALID) = 0;
  virtual csPtr<iTextureHandle> LoadTexture (const char* Filename,
        int Flags = CS_TEXTURE_3D, iTextureManager *tm = 0,
        csRef<iImage>* image=0) = 0;
  virtual iTextureWrapper* LoadTexture (const char *Name,
        const char *FileName,
        int Flags = CS_TEXTURE_3D, iTextureManager *tm = 0,
        bool reg = true, bool create_material = true,
        bool free_image = true, iRegion* region = 0) = 0;

  virtual csPtr<iImage> LoadImage (iDataBuffer* buf,
    int Format = CS_IMGFMT_INVALID) = 0;
  virtual csPtr<iTextureHandle> LoadTexture (iDataBuffer* buf,
        int Flags = CS_TEXTURE_3D, iTextureManager *tm = 0,
        csRef<iImage>* image=0) = 0;
  virtual iTextureWrapper* LoadTexture (const char *Name,
        iDataBuffer* buf,
        int Flags = CS_TEXTURE_3D, iTextureManager *tm = 0,
        bool reg = true, bool create_material = true,
        bool free_image = true) = 0;

  virtual csPtr<iSndSysData> LoadSoundSysData (const char *fname) = 0;
  virtual csPtr<iSndSysStream> LoadSoundStream (const char *fname,
        int mode3d) = 0;
  CS_DEPRECATED_METHOD_MSG("Use LoadSoundStream() without mode3d parameter instead.")
  virtual iSndSysWrapper* LoadSoundWrapper (const char *name,
        const char *fname, int mode3d) = 0;

  virtual iSndSysWrapper* LoadSoundWrapper (const char *name,
        const char *fname) = 0;

  virtual csPtr<iLoaderStatus> ThreadedLoadMapFile (const char* filename,
        iRegion* region = 0, bool curRegOnly = true,
        bool checkDupes = false) = 0;

  virtual bool LoadMapFile (const char* filename, bool clearEngine = true,
        iRegion* region = 0, bool curRegOnly = true,
        bool checkDupes = false, iStreamSource* ssource = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual bool LoadMap (iDocumentNode* world_node, bool clearEngine = true,
        iRegion* region = 0, bool curRegOnly = true,
        bool checkDupes = false, iStreamSource* ssource = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual bool LoadLibraryFile (const char* filename, iRegion* region = 0,
        bool curRegOnly = true, bool checkDupes = false,
        iStreamSource* ssource = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual bool LoadLibrary (iDocumentNode* lib_node, iRegion* region = 0,
        bool curRegOnly = true, bool checkDupes = false,
        iStreamSource* ssource = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual csPtr<iMeshFactoryWrapper> LoadMeshObjectFactory (
        const char* fname, iStreamSource* ssource = 0) = 0;
  virtual csPtr<iMeshWrapper> LoadMeshObject (const char* fname,
        iStreamSource* ssource = 0) = 0;

  virtual bool Load (const char* fname, iBase*& result, iRegion* region = 0,
        bool curRegOnly = true, bool checkDupes = false,
        iStreamSource* ssource = 0, const char* override_name = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual bool Load (iDataBuffer* buffer, iBase*& result, iRegion* region = 0,
        bool curRegOnly = true, bool checkDupes = false,
        iStreamSource* ssource = 0, const char* override_name = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual bool Load (iDocumentNode* node, iBase*& result, iRegion* region = 0,
        bool curRegOnly = true, bool checkDupes = false,
        iStreamSource* ssource = 0, const char* override_name = 0,
        iMissingLoaderData* missingdata = 0) = 0;

  virtual bool LoadShader (const char* filename) = 0;
  
  virtual void SetAutoRegions (bool autoRegions) = 0;
  
  virtual bool GetAutoRegions () = 0;
};

#endif // __CS_IMAP_PARSER_H__

---