include/gdb/oldGdbTerrainReader.h

Go to the documentation of this file.

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

//
// \file oldGdbTerrainReader.h
// \brief This file contains the DtOldGdbTerrainReader class declaration and other, related declarations.
//

#include "gdb/gdbDefines.h"
#include "gdb/gdbTerrainReader.h"
#include "terrainCS/coordSystem.h"
#include "gdb/terModCbInfo.h"
#include "gdb/terrainDb.h"
#include <vlutil/vlConfig.h>
#include <vector>
#include <map>


class DtBaseCoordinateSystem;
class DtSurfaceManager;
class DtOldGdbTerrainReader;
class DtSpecificationManager;
class DtSurfaceManager;
class DtFeature;
class DtNodeMap;

// Declare a namespace to make sure there are no conflicts with the node types
// declared in the DtGdbNode class and that you can use in a forward declaration.
namespace DT_GDB_VOLD
{
   typedef enum
   {
      NULL_NODE = -1,              
      GRIDPOST_LIST = 0,          // = 0
      VERTEX_LIST,                // = 1
      SURFACE_LIST,               // = 2
      GROUP,                      // = 3
      POLYGON_IMMEDIATE,          // = 4
      POLYGON_INDIRECT,           // = 5
      LEVEL_OF_DETAIL,            // = 6
      GRID,                       // = 7
      DYNAMIC_COORDINATE_SYSTEM,  // = 8
      STATIC_COORDINATE_SYSTEM,   // = 9
      TERRAIN_FEATURE,            // = 10
      CULTURAL_FEATURE,           // = 11
      BUILDING,                   // = 12
      TREE,                       // = 13
      TRIANGLE_IMMEDIATE,         // = 14
      TRIANGLE_INDIRECT,          // = 15
      FILE_NODE,                  // = 16
      REF_GROUP,                  // = 17
      SPECIFICATION_LIST,         // = 18
      VECTOR_NETWORK,             // = 19
      LAST_NODE_TYPE
   } DtOldGdbNodeType;
}

// Declares a function pointer typedef so that users can register reader functions to
// process the appropriate nodes while reading the old gdb file.
typedef DtGdbNode* (*DtOldGdbTerrainReaderNodeFcn)(DT_GDB_VOLD::DtOldGdbNodeType, 
   FILE *, DtOldGdbTerrainReader *, DtGroup *);


//
// The DtOldGdbTerrainReader represents an entire database in GDB format. 
// It is an old and deprecated file format, which can only be read in, not 
// written out.  
class DT_DLL_gdb DtOldGdbTerrainReader : public DtGdbTerrainReader
{
public:
  
   // default constructor
   DtOldGdbTerrainReader();

   // destructor
   virtual ~DtOldGdbTerrainReader();

private:
   // Copy constructor and Assignment operator not implemented
   DtOldGdbTerrainReader(const DtOldGdbTerrainReader& original);
   const DtOldGdbTerrainReader& operator=(const DtOldGdbTerrainReader& original);
      
public:

   static DtTerrainReader* create();

   // Returns the type of file this database was loaded from.
   // This class returns "oldgdb".  Override this function in derived
   // terrain db classes.
   virtual const DtString dataType() const;

   virtual bool readFromFile(const DtFilename& basename, DtTerrainDatabase* terrain);

protected:

   // I/O calls.
   virtual bool readCoordinateSystem(FILE* fp);
   virtual bool readFrom(FILE* fp, DtTerrainDatabase* terrain);
   virtual DtGdbNode* readGdbNodePointer(FILE* fp);

   virtual bool setReadFcn(DT_GDB_VOLD::DtOldGdbNodeType type, DtOldGdbTerrainReaderNodeFcn fun);
   virtual DtOldGdbTerrainReaderNodeFcn readFcn(DT_GDB_VOLD::DtOldGdbNodeType type);
   
   virtual bool validityCheckVersionNumber(unsigned int versionNumberFromFile);
   virtual bool readTerrainData(FILE* fp);

   virtual bool adjustNewIndirectNodes(DtTerrainDatabase* terrainDb);

   virtual DtGdbNode* readNode(FILE* fp, DtGroup* parent, bool likelyToBeReferenced = false);

   static DtGdbNode* readGridPostList(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readVertexList(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readGroup(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readPolyInd(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readGrid(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readFileNode(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readRefGroup(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readSpecificationList(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readVectorNetwork(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);

   static DtGdbNode* readSurfaceList(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode *readPolyImm(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readLOD(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readDynamicCoordSys(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readStaticCoordSys(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readTerrainFeature(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readCulturalFeature(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readBuilding(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readTree(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readTriangleImm(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);
   static DtGdbNode* readTriangleInd(DT_GDB_VOLD::DtOldGdbNodeType type, FILE *fp, DtOldGdbTerrainReader *me, DtGroup *parent);

   virtual bool readSurface(FILE *fp, DtSurface& surface);
   virtual bool readFeature(FILE *fp, DtFeature* feature);

   virtual bool readCoordSys(FILE* fp, DtBaseCoordinateSystem* coordSys);

protected:

   DtNodeMap* myNodeMap;
   
   typedef std::map<DT_GDB_VOLD::DtOldGdbNodeType, DtOldGdbTerrainReaderNodeFcn> DtNodeReaderFunctions;
   typedef DtNodeReaderFunctions::iterator DtNodeReaderFcnIter;
   typedef DtNodeReaderFunctions::const_iterator DtNodeReaderFcnConstIter;

   DtNodeReaderFunctions myReaderFunctions;

   DtSurfaceManager* mySurfaceMgrPtr;

   // These are used to read in immediate polygons and triangles and to convert 
   // them to indirect without corrupting the indices already stored for existing
   // indirect polys/tris' vertices and surfaces.  Both should be added to the 
   // end of the main VertexManager and SurfaceManager and all IDs updated before 
   // returning from loading.
   DtVertexManager myImmPolyVertexManager;
   DtSurfaceManager myImmPolySurfaceManager;

   // Array of pointers to all indirect triangle and polygon nodes that were 
   // created from immediate nodes on disk.  Use this to go back and adjust 
   // the appropriate IDs (surface...) after all others are loaded.
   std::vector<DtPolygonIndirect*> myImmPolyNodes;
   std::vector<DtTriangleIndirect*> myImmTriNodes;
};

#endif