include/terrainDbFactory/tdbManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1998 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: tdbManager.h,v $ $Revision: 1.23 $ $State: Exp $
*******************************************************************************/
#ifndef tdbManager_H_
#define tdbManager_H_

// \file tdbManager.h
// \brief This file contains the declaration of the DtTdbManager class.

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "gdb/terrainSelection.h"

class DtList;
class DtTerrainDatabase;
class DtPaperMapDatabase;
class DtString;
class DtFilename;

class Coordinate_System;
class DtExtent;
class DtTerrainDbFactory;
class DtTdbMetafile;
class DtNetworkElement;
class DtGdbProcessingMetafileRecord;
class DtPaperMap;
class DtPaperMapRecord;
class DtTdbManager;
class Coordinate_System;

typedef bool(*DtCheckImageForValidityCallbackFcn)(const DtTerrainDatabase*, const DtString& path, DtPaperMap*, DtPaperMapRecord*,
                                                  Coordinate_System*, DtPaperMap*&, void*);

class DT_DLL_terrainDbFactory DtTdbManager
{

public:
   
   DtTdbManager();

   DtTdbManager(DtTerrainDbFactory* fac);

   virtual ~DtTdbManager();

private:

   DtTdbManager(const DtTdbManager& orig);
   DtTdbManager& operator=(const DtTdbManager& rhs);

public:

   virtual bool load(const DtFilename& filename, const DtList &searchPaths, DtString* errorString = 0);

   virtual bool load(const DtFilename & filename,const DtFilename & path=DtFilename::nullFilename(), DtString* errorString = 0);

   virtual bool load(DtTdbMetafile& tdbMeta,const DtFilename & path=DtFilename::nullFilename(), DtString* errorString = 0 );

   // Returns a coordinate system from the specified file.  Use this call rather than load if all you are interested in
   // is the coordinate system.  Note that you will need to delete the coordinate system object returned to prevent a
   // memory leak
   virtual Coordinate_System* coordinateSystemFrom(const DtFilename&,
      const DtFilename & path=DtFilename::nullFilename(), DtString* errorString = 0);

   // Returns true if the flags are set in the specified database
   virtual bool hasOptionalFlags(int flags, const DtFilename&,
      const DtFilename & path=DtFilename::nullFilename(), DtString* errorString = 0);

   virtual bool loadPapermaps(DtTdbMetafile& tdbMeta, DtTerrainDatabase* db, const DtFilename & path=DtFilename::nullFilename());

   virtual bool save(const DtFilename& filename);

   virtual bool exportPoly(const DtFilename& filename);

   virtual bool createDatabaseFromExtent(const DtExtent&, Coordinate_System* coordSys = 0);

   virtual bool unload();


   virtual bool selectTerrain(const DtVector& localLocation, 
      DtTerrainSelection& terrainSelection);

   virtual bool selectTerrain(double lat, double lon, 
      DtTerrainSelection& terrainSelection);

   virtual bool selectTerrain(const DtExtent& extent, 
      DtTerrainSelection& terrainSelection, bool selectInclusive = true);
   virtual bool selectTerrain(const DtNetworkElement& networkElement, 
      DtTerrainSelection& terrainSelection, bool selectInclusive = true);

   virtual bool processDatabase(DtTerrainDatabase& terrainDatabase,
      const DtGdbProcessingMetafileRecord& postProcessingRecord) const;
   
   virtual void setTerrainFactory(DtTerrainDbFactory* fac);
   virtual DtTerrainDbFactory* terrainDbFactory();

   virtual const DtTerrainDatabase* terrainDatabase() const;
   virtual DtTerrainDatabase* terrainDatabase();
   virtual void setTerrainDatabase(DtTerrainDatabase* t);

   virtual const DtPaperMapDatabase* paperMapDatabase() const;
   virtual DtPaperMapDatabase* paperMapDatabase();
   virtual void setPaperMapDatabase(DtPaperMapDatabase* p);

   static DtTdbManager* create(DtTerrainDbFactory*);

   virtual DtTerrainDatabase* createTerrainDatabase();

   void setCheckImageForValidityCallback(DtCheckImageForValidityCallbackFcn, void*);
   DtCheckImageForValidityCallbackFcn checkImageForValidityCallback(void*& userPtr) const;

   virtual bool loadFor3DVisualization(const DtFilename& filename, 
      Coordinate_System* targetCoordinateSystem = 0, DtString* errorString = 0);

   // Loads feature data from the specified feature data source, and merges them
   // into the specified terrain database.
   // Loads from:  GDB, .dfd, and .shp files.
   virtual bool loadFeatureDataIntoTerrain(const DtFilename& featureDataFilename,
      DtTerrainDatabase& terrainDb);

   // \return myLoadedTerrainFilename.
   virtual DtString loadedTerrainFilename() const;

   // \brief Sets a flag indicating that paged terrains should be fully loaded.
   virtual void setFullyLoad(bool);
   virtual bool fullyLoad() const;
protected:

   DtTerrainDbFactory* myTerrainDbFactory;
   DtTerrainDatabase*  myTerrainDatabase;
   DtPaperMapDatabase* myPaperMapDatabase;
   DtCheckImageForValidityCallbackFcn myCheckImageForValidityCallback;
   void* myCheckImageForValidityCallbackData;

   // The filename of the terrain that was passed into the load() method
   // to load the terrain.  If a metafile was passed in, this will be the name stored.
   DtString myLoadedTerrainFilename;

   bool myFullyLoad;
};

#endif