include/gdb/terrainReader.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1999 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: terrainReader.h,v $ $Revision: 1.21 $ $State: Exp $
*******************************************************************************/
#ifndef terrainReader_H_
#define terrainReader_H_

// \file terrainReader.h
// \brief Contains the DtTerrainReader class declaration.

#include "gdb/gdbDefines.h"
#include <vlutil/vlFilename.h>

enum DtTerrainFileVersionNumber
{
   OLD_TDB_FILE_FORMAT_VERSION = 100,
   TDB_FILE_FORMAT_VERSION = 200,
   TDB_FILENODE_VERSION = 201,
   TDB_DATA_FLAGS_VERSION = 202,
   TDB_VECTOR_DATA_VERSION = 203,
   TDB_204_VERSION = 204,
   TDB_205_VERSION = 205,
   TDB_206_VERSION = 206,
   TDB_207_VERSION = 207,
   TDB_208_VERSION = 208,
   TDB_209_VERSION = 209,
   TDB_210_VERSION = 210
};


class DtTerrainDatabase;
class DtTerrainInitializer;
class DtTerrainFileInitializer;
class Coordinate_System;

//
// DtTerrainReader is an abstract class that represents a reader for any format
class DT_DLL_gdb DtTerrainReader
{
public:
  
   // default constructor
   DtTerrainReader();

   // Loads terrain database file named filename, returning the data in 
   // terrain.  The terrain pointer passed in must be initialized before calling 
   // loadTerrain.
   virtual bool loadTerrain(const DtFilename& filename, 
                            DtTerrainDatabase* terrain) = 0;

   // Loads terrain database file named filename, returning the data in 
   // terrain.  The initializer object is used to pass in additional information
   // about the terrain to be loaded.  The terrain pointer passed in must be 
   // initialized before calling loadTerrain.
   virtual bool loadTerrain(const DtFilename& filename, 
                            DtTerrainDatabase* terrain, 
                            const DtTerrainInitializer* initializer) = 0;

   // destructor
   virtual ~DtTerrainReader();

   virtual DtTerrainDatabase *terrainDb();

   // Pre-processes the terrain if specified in any way in the initializer, such
   // as preallocating the expected number of vertices and surfaces to hold.
   virtual bool preprocessTerrain(const DtTerrainFileInitializer& terrainInitializer, 
      DtTerrainDatabase& terrainDb) const;

   virtual const DtString dataType() const = 0;

   void setTerrainInitializer(const DtTerrainInitializer* initializer);
   const DtTerrainInitializer* terrainInitializer() const;

   // Returns only the coordinate system that would define this database.  Should not load
   // any polygonal or vector information
   virtual Coordinate_System* coordinateSystem(const DtFilename& filename) = 0;

   // Returns only optional file flags.  Should not load
   // any polygonal or vector information
   virtual int optionalFileFlags(const DtFilename& filename) = 0;

protected:

   // initialize the reader when loading, is called inside of loadTerrain
   virtual void init(const DtFilename& filename, DtTerrainDatabase* terrain);

   // copy constructor
   DtTerrainReader(const DtTerrainReader& orig);

   // assignment operator
   DtTerrainReader& operator=(const DtTerrainReader& orig);

protected:

   DtTerrainDatabase* myTerrainDatabase;
   DtFilename         myFilename;

   const DtTerrainInitializer* myTerrainInitializer;
};

inline DtTerrainDatabase* DtTerrainReader::terrainDb()
{
   return myTerrainDatabase;
}

inline void DtTerrainReader::setTerrainInitializer(
   const DtTerrainInitializer* initializer)
{
   myTerrainInitializer = initializer;
}

inline const DtTerrainInitializer* DtTerrainReader::terrainInitializer() const
{
   return myTerrainInitializer;
}

#endif