include/gdb/terrainIntersector.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: terrainIntersector.h,v $ $Revision: 1.17 $ $State: Exp $
*******************************************************************************/


#ifndef terrainIntersector_h
#define terrainIntersector_h

#include "gdb/gdbDefines.h"
#include "gdb/gdbNode.h"

class DtTerrainDatabase;
class DtPoint;
class DtChord;
class DtChordIntersectionRecord;
class DtSphereIntersectionRecord;
class DtTerrainIntersectorDescriptor;

// Common place to keep all current intersector types
const int DtBaseTerrainIntersectorType = 0;
const int DtSpatialSubdivisionTerrainIntersectorType = 1;
const int DtOpcodeTerrainIntersectorType = 2;

// Abstract base class for intersectors used in a DtTerrainDatabase.
// Subclasses of this interface class implement the actual intersection
// methods for getting intersections with the polygonal terrain data.
class DT_DLL_gdb DtTerrainIntersector
{
private:
   // Not implemented.
   DtTerrainIntersector();
   // Not implemented.
   DtTerrainIntersector(const DtTerrainIntersector& orig);
   // Not implemented.
   DtTerrainIntersector& operator=(const DtTerrainIntersector& orig);

public:
   // Provide the terrain database and descriptor to instantiate a terrain intersector.
   // The descriptor is cloned and held internally by the intersector.
   DtTerrainIntersector(DtTerrainDatabase* db,
      const DtTerrainIntersectorDescriptor* descriptor);
   virtual ~DtTerrainIntersector();

   // Called for first time init
   virtual bool init() = 0;

   // Called when something has changed about the underlying terrain database and the intersector
   // needs to be reinitialized
   virtual bool reinitialize() = 0;

   // \return The total number of bytes of memory used by this intersector
   // and any of its internal indexing into the terrain.
   virtual unsigned int memoryUsage() const = 0;

   virtual int terrainIntersectorType() const = 0;

   virtual bool chordIntersect(const DtChord& chord,
      DtChordIntersectionRecord& record,
      DtGdbNode::DtIntersectRecordType irtFlag = DtGdbNode::IRT_ALL_DATA_TERRAIN) const = 0;

   virtual bool allIntersectsAlongChord(const DtChord& chord,
      DtChordIntersectRecordList& intList,
      DtGdbNode::DtIntersectRecordType irtFlag = DtGdbNode::IRT_ALL_DATA_TERRAIN) const = 0;

   virtual bool sphereIntersect(const DtSphere& sphere, DtSphereIntersectionRecord& record,
      DtGdbNode::DtIntersectRecordType irtFlag = DtGdbNode::IRT_ALL_DATA_TERRAIN) const = 0;

   virtual DtTerrainDatabase* terrainDatabase() const { return myTerrainDatabase; };
   virtual DtTerrainDatabase* terrainDatabase() { return myTerrainDatabase; };

   // \return A pointer to the descriptor used by this intersector.
   virtual const DtTerrainIntersectorDescriptor* descriptor() const;

   // Called to return information about this intersector.  Calls down to the descriptor to return the information
   virtual void intersectorInformation(DtString& name, DtString& properties) const;

protected:
   DtTerrainDatabase*   myTerrainDatabase;
   DtTerrainIntersectorDescriptor* myDescriptor;
};

#endif