include/gdb/rangeDirNetSegMet.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: rangeDirNetSegMet.h,v $ $Revision: 1.3 $ $State: Exp $
*********************************************************************/

#pragma once

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

// class DtRangeAndDirectionNetworkSegmentMetric:
//
// DtRangeAndDirectionNetworkSegmentMetric is a metric for segments in an
// mx-cif quadtree.  This metric extends DtRangeNetworkSegmentMetric
// to to additionally match a specified direction of the segment to within
// a specified tolerance.
// @see DtRangeNetworkSegmentMetric
class DT_DLL_gdb DtRangeAndDirectionNetworkSegmentMetric : public DtRangeNetworkSegmentMetric
{

public:

   DtRangeAndDirectionNetworkSegmentMetric();

   DtRangeAndDirectionNetworkSegmentMetric(const DtRangeAndDirectionNetworkSegmentMetric& orig);

   DtRangeAndDirectionNetworkSegmentMetric& operator=(const DtRangeAndDirectionNetworkSegmentMetric& orig);

   virtual ~DtRangeAndDirectionNetworkSegmentMetric();

   virtual bool valid(const DtNetworkSegment& seg) const;

   virtual bool testDirection(const DtPoint& p1, const DtPoint& p2) const;

   virtual void setDirectionOfInterest(double direction);
   virtual double directionOfInterest() const;

   virtual void setDirectionTolerance(double tolerance);
   virtual double directionTolerance() const;

   // @{
   // Get/set whether segments should be considered bidirectional
   // when testing for direction.
   // Default is true.
   virtual void setSearchBidirectional(bool bidi);
   virtual bool searchBidirectional() const;
   // @}

   // Returns the direction of the segment defined by point0 and
   // point1 in local coordinate radians.
   virtual double directionOfSegment(const DtPoint& point0, 
         const DtPoint& point1) const;

protected:

   double myDirection;
   double myDirectionTolerance;
   bool   mySearchBidirectional;
};