include/terrainInterface/terrainImplementation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "terrainInterface/terrainInterfaceDefines.h"
#include <geometry/intersectionRecord.h>
#include <geometry/chord.h>
#include <gdb/vecNetwrkRecord.h>
#include <gdb/vecNwrkIntRec.h>
#include <geometry/intRecLst.h>
#include "tdbutil/stringKeyFactory.h"
#include "terrainInterface/terrainPagingGeometry.h"
#include "terrainInterface/terrainProcessPolygonsBox.h"

class DtChordIntersectionRecord;
class DtSphereIntersectionRecord;
class DtString;
class Coordinate_System;
class DtVectorNetwork;
class DtConsoleCommandManager;
class DtTerrainCapabilities;

namespace makArchives
{
   class DtGenericTerrainRecord;
}

class DT_DLL_terrainInterface DtTerrainImplementation
{
public:
   typedef std::map<std::string, std::string> TerrainSettings;

private:

   DtTerrainImplementation();
   DtTerrainImplementation(const DtTerrainImplementation& orig);
   DtTerrainImplementation& operator=(const DtTerrainImplementation& orig);
public:
   DtTerrainImplementation(DtConsoleCommandManager* cmdManager);
   virtual ~DtTerrainImplementation();

   virtual bool loadTerrain(const makArchives::DtGenericTerrainRecord& rec,
      const TerrainSettings& settings = TerrainSettings()) = 0;

   virtual const Coordinate_System* coordinateSystem() const = 0;

   virtual bool chordIntersect(const DtChord& chord,
      DtChordIntersectionRecord& record,
      DtIntersectionRecord::DtIntersectionType irtFlag = 
      DtIntersectionRecord::INT_ALL_DATA, bool* dataAvailable = 0,
      bool overrideBlockingAssert = false) const = 0;

   virtual bool allIntersectsAlongChord(const DtChord& chord,
      DtChordIntersectRecordList& intList,
      DtIntersectionRecord::DtIntersectionType irtFlag = 
      DtIntersectionRecord::INT_ALL_DATA, bool* dataAvailable = 0,
      bool overrideBlockingAssert = false) const = 0;

   virtual bool sphereIntersect(const DtSphere& sphere, 
      DtSphereIntersectionRecord& record,
      DtIntersectionRecord::DtIntersectionType irtFlag = 
      DtIntersectionRecord::INT_ALL_DATA, bool* dataAvailable = 0,
      bool overrideBlockingAssert = false) const = 0;

   virtual bool intersectVectorNetwork(const DtChord& chord,
      DtVectorNetworkRecord* vectorRecord, 
      DtVectorNetworkIntersectionRecord* vectorIntersectionRecord) const = 0;

   virtual const DtVectorNetwork* vectorNetwork() const = 0;

   virtual void preloadTerrainAreas(
      const DtTerrainPagingGeometryList& preloadGeometry) {};

   virtual const DtTerrainCapabilities* terrainCapabilities() const = 0;

   virtual void setAssertOnBlockingTerrainCalls(bool assertBlock);
   virtual bool assertOnBlockingTerrainCalls() const;

   virtual void setIntersectDataLoadExpireTime(const double& expireTime) {};

   virtual void expireDataLoadRequestsBeforeTime(const double& currentTime) {};

   virtual void processTrianglesInArea(DtTriangleCallbackFcn func, DtTriangleCallbackFinalizeFcn finalize, DtTerrainProcessPolygonsBox& box, void* usr) const;

protected:
   bool myAssertOnBlockingTerrainCalls;

   TerrainSettings mySettings;
};

typedef DtStringKeyFactoryWithParam<DtTerrainImplementation, 
   DtConsoleCommandManager*> DtTerrainImplementationFactory;
typedef DtTerrainImplementationFactory::DtCreatorFcn 
   DtTerrainImplementationCreatorFcn;