include/gdb/gdbTerrainV203Reader.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1999 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: gdbTerrainV203Reader.h,v $ $Revision: 1.18 $ $State: Exp $
*********************************************************************/

#ifndef gdbTerrainV203Reader_H_
#define gdbTerrainV203Reader_H_

#include "gdb/gdbDefines.h"
#include <stdio.h>
#include "terrainCS/coordSystem.h"
#include "gdb/terModCbInfo.h"
#include "gdb/gdbTerrainReader.h"

#include "gdb/terrainDb.h"
#include "geometry/spatialSubdivision.h"

//forward declarations
class DtExtent;
class DtChord;
class DtChordBundle;
class DtChordIntersectionRecord;
class DtChordIntersectRecordList;
class DtColor;
class DtMemoryManager;
class DtAllTypesPolygon;
class DtTerrainInitializer;
class DtBaseCoordinateSystem;
class DtNetworkNode;
class DtNetworkSegmentHelper;
class DtNetworkEdge;
class DtNetworkSpecElement;
class DtFeature;
class DtGroup;
class DtSurface;
class DtGdbTerrainV203Reader;
class DtListMap;

// 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_V203
{
   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
   } DtGdbV203NodeType;
}


typedef DtGdbNode* (*DtGdbTerrainV203ReaderNodeFcn)(DT_GDB_V203::DtGdbV203NodeType, FILE *, DtGdbTerrainV203Reader *, DtGroup *);

// class DtGdbTerrainV203Reader:
//
// DtGdbTerrainV203Reader represents an entire database in GDB
// format. It is assumed to be a group node (is this appropriate?? -- RVK).
// The database can be written out to, and read from, a file.
// NOTE:  This class used to be the DtGdbTerrainReader until that was
// changed to be a general gdb file loader that used the specific loaders
// for each version and the functionality for loading gdb files with 
// versions between OLD and 203 was moved into this class.


class DT_DLL_gdb DtGdbTerrainV203Reader : public DtGdbTerrainReader
{
public:

   // default constructor
   DtGdbTerrainV203Reader();

   // destructor
   virtual ~DtGdbTerrainV203Reader();

private:
   // copy constructor and assignment operator not implemented
   DtGdbTerrainV203Reader(const DtGdbTerrainV203Reader& orig);
   DtGdbTerrainV203Reader& operator=(const DtGdbTerrainV203Reader& orig);

public:

   static DtTerrainReader* create();

   // Returns the type of file this database was loaded from.
   // This class returns "gdb".  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 readFrom(FILE* fp, DtTerrainDatabase *terrain);

   virtual bool validityCheckVersionNumber(unsigned int versionNumberFromFile);
   virtual bool readTerrainData(FILE* fp);
   virtual bool readOptionalData(FILE* fp);
   virtual bool adjustNewIndirectNodes(DtTerrainDatabase* terrainDb);

   virtual DtGdbNode* readNode(FILE *fp, DtGroup *parent);

   virtual bool setReadFcn(DT_GDB_V203::DtGdbV203NodeType type, DtGdbTerrainV203ReaderNodeFcn fun);
   virtual DtGdbTerrainV203ReaderNodeFcn readFcn(DT_GDB_V203::DtGdbV203NodeType type);

   static DtGdbNode* readGridPostList(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readVertexList(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readGroup(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readPolyImm(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readPolyInd(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readLOD(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readGrid(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readDynamicCoordSys(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readStaticCoordSys(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readTerrainFeature(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readCulturalFeature(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readBuilding(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readTree(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readTriangleImm(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readTriangleInd(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readFileNode(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readVectorNetwork(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readSurfaceList(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);
   static DtGdbNode* readSpecificationList(DT_GDB_V203::DtGdbV203NodeType type, FILE *fp, DtGdbTerrainV203Reader *me, DtGroup *parent);

   virtual bool readSurface(FILE* fp, DtSurface& surface);
   // functions to read vector networks
   virtual bool readNetworkNode(FILE* fp, DtNetworkNode* node, unsigned int topology, int numEdges);
   
   virtual bool readNetworkSpecElement(FILE* fp, DtNetworkSpecElement* elem);
   
   virtual bool readNetworkSegment(FILE* fp, DtNetworkSegmentHelper* seg, unsigned int topology);

   virtual bool readNetworkEdge(FILE* fp, 
                                DtNetworkEdge* edge, 
                                unsigned int topology,
                                unsigned int& numSegments,
                                std::vector<unsigned int>& segmentIndices,
                                unsigned int& startNodeIndex,
                                unsigned int& endNodeIndex);

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

   virtual bool readFeature(FILE* fp, DtFeature* feature);

   // While reading a GDB file, reports whether this database will contain
   // optional data
   bool fileHasOptionalData(DtTerrainFileOptionalData optData);

protected:

   // For debugging purposes - prints out the numbers of the different nodes 
   // and other file data (number of specifications, vertices, etc.) read in
   virtual void printReadNodeCount();

   DtListMap*                 myVertexListMap;
   DtListMap*                 mySurfaceListMap;
   DtListMap*                 mySpecificationListMap;

   unsigned int   myOptionalDataFlagFromFile;

   // 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.
   DtList myImmPolyNodeList;
   DtList myImmTriNodeList;

   DtGdbTerrainV203ReaderNodeFcn *myReaderFunctionTable;
};

// While reading a GDB file, reports whether this database will contain
// optional data
inline bool DtGdbTerrainV203Reader::fileHasOptionalData(
   DtTerrainFileOptionalData optData)
{
   if (myOptionalDataFlagFromFile & optData)
   {
      return true;
   }
   else
   {
      return false;
   }
}

#endif