include/gdb/terrainSelectionTool.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: terrainSelectionTool.h,v $ $Revision: 1.9 $ $State: Exp $
******************************************************************************/
#ifndef terrainSelectionTool_H_
#define terrainSelectionTool_H_

//
// \file terrainSelectionTool.h
// \brief This file contains classes related to selecting arbitrary sections of
// terrain, composed of terrain elements (usually polygons), from a terrain database.  
//

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

class DtTerrainDatabase;
class DtNetworkElement;
class DtNetworkEdge;
class DtNetworkNode;
class DtNetworkSegment;
class DtSpecification;
class DtExtent;
class DtVector;
class DtPolygon2D;
class DtGdbNode;
class DtCircle;

//
// \brief The DtTerrainSelectionTool provides an interface for selecting terrain
// elements from a specified terrain database or terrain selection, usually using
// a geometric primitive such as a chord or extent as the selection mechanism.
class DT_DLL_gdb DtTerrainSelectionTool
{
public:
   DtTerrainSelectionTool();

   virtual ~DtTerrainSelectionTool();

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

   // \defgroup TerrainSelection
   //
   // Given the specified terrain database or terrain selection, selection 
   // primitive, and terrain selection, use the primitive to select the 
   // appropriate terrain elements, if any. 
   //
   // \return A boolean indication whether or not any terrain was selected.
   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      const DtVector& localLocation, DtTerrainSelection& terrainSelection) const;

   virtual bool selectTerrain(DtTerrainSelection& roughTerrainSelection, 
      const DtVector& localLocation, DtTerrainSelection& refinedTerrainSelection) const;

   
   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      double lat, double lon, DtTerrainSelection& terrainSelection) const;

   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      const DtExtent& extent, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;

   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      const DtNetworkElement& networkElement, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;


   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      const DtPolygon2D& selectionPrimitive, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;
   virtual bool selectTerrain(DtTerrainSelection& roughTerrainSelection, 
      const DtPolygon2D& selectionPrimitive, DtTerrainSelection& refinedTerrainSelection, 
      bool selectInclusive = true) const;


   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      const DtCircle& circle, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;
   virtual bool selectTerrain(DtTerrainSelection& roughTerrainSelection, 
      const DtCircle& circle, DtTerrainSelection& refinedTerrainSelection, 
      bool selectInclusive = true) const;


   virtual bool selectTerrain(DtTerrainDatabase& terrainDatabase, 
      DtGdbNode::DtGdbNodeType nodeType, 
      DtTerrainSelection& terrainSelection);


   virtual bool selectTerrainUsingSegment(DtTerrainSelection& roughTerrainSelection, 
      const DtNetworkSegment& segment, const DtSpecification& segmentSpec, 
      DtTerrainSelection& refinedTerrainSelection, bool selectInclusive = true) const;

   virtual bool selectTerrainUsingLinearFeature(DtTerrainDatabase& terrainDatabase, 
      const DtNetworkEdge& linearFeature, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;

   virtual bool selectTerrainUsingArealFeature(DtTerrainDatabase& terrainDatabase, 
      const DtNetworkEdge& arealFeature, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;

   virtual bool selectTerrainUsingPointFeature(DtTerrainDatabase& terrainDatabase, 
      const DtNetworkNode& node, DtTerrainSelection& terrainSelection, 
      bool selectInclusive = true) const;
   
   virtual bool getTerrainElements(DtGdbNode& node, 
      DtTerrainSelection& terrainSelection) const;

   virtual bool getRoughSelection(DtTerrainDatabase& terrainDatabase, 
      const DtExtent& boundingExtent, DtTerrainSelection& terrinSelection) const;

   // \return A boolean indicating whether or not the edge intersects the 
   // specified terrain element when projected in XY.
   virtual bool intersectsTerrainElementInXy(const DtVector& location, 
      const DtTerrainElement& terrainElement) const;
   
   virtual bool intersectsTerrainElementInXy(const DtChord& edge, 
      const DtTerrainElement& terrainElement) const;

   virtual bool intersectsTerrainElementInXy(const DtPolygon2D& polygon2d,
      const DtTerrainElement& terrainElement) const;

   virtual bool intersectsTerrainElementInXy(const DtCircle& circle, 
      const DtTerrainElement& terrainElement) const;

   virtual bool boundsTerrainElementInXy(const DtPolygon2D& polygon2d, 
      const DtTerrainElement& terrainElement) const;

   virtual bool boundsTerrainElementInXy(const DtCircle& circle, 
      const DtTerrainElement& terrainElement) const;

protected:
private:

};

#endif