networkSegment.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2001 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: netwrkSeg.h,v $ $Revision: 1.21 $ $State: Exp $
*******************************************************************************/
// \file netwrkSeg.h
// \brief Contains the DtNetworkSegment class declaration.

#ifndef networkSegment_H_
#define networkSegment_H_

#include "gdb/gdbDefines.h"
#include <vlutil/vlConfig.h>
#include "geometry/chord.h"
#include "gdb/specificationManager.h"
#include "gdb/networkElement.h"
#include <vlutil/vlString.h>

class DtNetworkEdge;

//
// DtNetworkSegment represents a section of a network that is approximated
// by a line segment. 
class DT_DLL_gdb DtNetworkSegment : public DtNetworkElement
{
public:

   // default constructor
   DtNetworkSegment();

   // destructor
   virtual ~DtNetworkSegment();

   // copy constructor
   DtNetworkSegment(const DtNetworkSegment& orig);

   // assignment operator
   DtNetworkSegment& operator=(const DtNetworkSegment& orig);

   // get/set chord
   virtual const DtChord chord() const;
   virtual void setPoints(int pt1, int pt2);
   virtual void increaseIndex(int val);

   // get/set parent edge
   virtual DtNetworkEdge* parentEdge();
   virtual const DtNetworkEdge* parentEdge() const;
   virtual void setParentEdge(DtNetworkEdge* edge);

   virtual DtString type();

   // first and last endpoint, as traversing forward
   virtual DtPoint endpoint0() const;
   virtual DtPoint endpoint1() const;

   virtual double length() const;

   // get specification
   virtual const DtSpecification& specification() const;

   // get boundary values
   virtual double minX() const;
   virtual double maxX() const;
   virtual double minY() const;
   virtual double maxY() const;
   virtual double minZ() const;
   virtual double maxZ() const;

   // Get the distance to a specified point
   // 
   // \param point the point to find the distance to
   // \return the distance to the specified point
   virtual double distanceToPoint(const DtPoint& point) const;

   // Get the distance in XY to the specified point
   // 
   // \param point the point to find the distance to
   // \return the distance (in the X,Y plane) to the specified point
   virtual double distanceToPointInXY(const DtPoint& pointIn) const;

   // Calculate if the projections onto the x-y plane of another segment 
   // and this segment intersect.  
   virtual bool xyIntersects(const DtNetworkSegment& seg) const;

   // Calculate if the projections onto the x-y plane of another segment 
   // and this segment intersect.  
   // \param distanceSquared The distance between the two segments squared,
   // \param thisX
   // \param thisY hold the closest points on this segment
   // \param otherX/otherY hold the closest point on the network segment.  
   virtual bool xyIntersects(const DtNetworkSegment& seg,
                             double& distanceSquared,
                             double& thisX, 
                             double& thisY,
                             double& otherX, 
                             double& otherY) const;

   // Find the closest point on the segment to another point
   // 
   // \param pointIn the point to find the closest point to
   // \param pointOut the closest point to the specified point
   // \param distance the distance from the closest point to the specified point
   // \deprecated TerrainToolkit 3.9
   virtual void closestPoint(const DtPoint& pointIn, 
                             DtPoint& closestPnt, 
                             double& distance) const;

   // Find the closest point, in 2D (x,y), on the segment to another point
   // 
   // \param pointIn the point to find the closest point to
   // \param pointOut the closest point, in 2D, to the specified point
   // \param distance the distance, in 2D, from the closest point to the specified point
   // \deprecated TerrainToolkit 3.9
   virtual void closestPointInXY(const DtPoint& pointIn, 
                                 DtPoint& pointOut, 
                                 double& distance) const;
protected:
   int myIndex1;
   int myIndex2;

   DtNetworkEdge*             myParentEdge;

   static const double        theParallelAngle;
};

#endif