GEOS  3.12.0
planargraph/DirectedEdge.h
1 /**********************************************************************
2  *
3  * GEOS - Geometry Engine Open Source
4  * http://geos.osgeo.org
5  *
6  * Copyright (C) 2001-2002 Vivid Solutions Inc.
7  * Copyright (C) 2005-2006 Refractions Research Inc.
8  *
9  * This is free software; you can redistribute and/or modify it under
10  * the terms of the GNU Lesser General Public Licence as published
11  * by the Free Software Foundation.
12  * See the COPYING file for more information.
13  *
14  **********************************************************************/
15 
16 #pragma once
17 
18 #include <geos/export.h>
19 #include <geos/planargraph/GraphComponent.h> // for inheritance
20 #include <geos/geom/Coordinate.h> // for composition
21 
22 #include <vector> // for typedefs
23 #include <list> // for typedefs
24 
25 // Forward declarations
26 namespace geos {
27 namespace planargraph {
28 class Edge;
29 class Node;
30 }
31 }
32 
33 namespace geos {
34 namespace planargraph { // geos.planargraph
35 
45 class GEOS_DLL DirectedEdge: public GraphComponent {
46 
47 public:
48 
49  friend std::ostream& operator << (std::ostream&, const DirectedEdge&);
50 
51  typedef std::list<DirectedEdge*> NonConstList;
52  typedef std::list<const DirectedEdge*> ConstList;
53  typedef std::vector<DirectedEdge*> NonConstVect;
54 
55 protected:
56  Edge* parentEdge;
57  Node* from;
58  Node* to;
59  geom::Coordinate p0, p1;
60  DirectedEdge* sym; // optional
61  bool edgeDirection;
62  int quadrant;
63  double angle;
64 public:
65 
66  typedef std::vector<const DirectedEdge*> ConstVect;
67  typedef std::vector<DirectedEdge*> Vect;
68 
78  static std::vector<Edge*>* toEdges(
79  std::vector<DirectedEdge*>& dirEdges);
80 
89  static void toEdges(std::vector<DirectedEdge*>& dirEdges,
90  std::vector<Edge*>& parentEdges);
91 
106  DirectedEdge(Node* newFrom, Node* newTo,
107  const geom::Coordinate& directionPt,
108  bool newEdgeDirection);
109 
114  Edge* getEdge() const;
115 
120  void setEdge(Edge* newParentEdge);
121 
126  int getQuadrant() const;
127 
133 
138  bool getEdgeDirection() const;
139 
143  Node* getFromNode() const;
144 
148  Node* getToNode() const;
149 
155 
161  double getAngle() const;
162 
169 
175  void setSym(DirectedEdge* newSym);
176 
196  int compareTo(const DirectedEdge* obj) const;
197 
217  int compareDirection(const DirectedEdge* e) const;
218 
224  std::string print() const;
225 
226 };
227 
229 bool pdeLessThan(DirectedEdge* first, DirectedEdge* second);
230 
232 std::ostream& operator << (std::ostream&, const DirectedEdge&);
233 
234 
235 } // namespace geos::planargraph
236 } // namespace geos
237 
geos::planargraph::DirectedEdge
Represents a directed edge in a PlanarGraph.
Definition: planargraph/DirectedEdge.h:45
geos::planargraph::DirectedEdge::setEdge
void setEdge(Edge *newParentEdge)
Associates this DirectedEdge with an Edge (possibly null, indicating no associated Edge).
geos::planargraph::DirectedEdge::getDirectionPt
const geom::Coordinate & getDirectionPt() const
Returns a point to which an imaginary line is drawn from the from-node to specify this DirectedEdge's...
geos::planargraph::DirectedEdge::compareDirection
int compareDirection(const DirectedEdge *e) const
Returns 1 if this DirectedEdge has a greater angle with the positive x-axis than b",...
geos
Basic namespace for all GEOS functionalities.
Definition: Angle.h:25
geos::planargraph::pdeLessThan
bool pdeLessThan(DirectedEdge *first, DirectedEdge *second)
Strict Weak comparator function for containers.
geos::planargraph::DirectedEdge::getEdgeDirection
bool getEdgeDirection() const
Returns whether the direction of the parent Edge (if any) is the same as that of this Directed Edge.
geos::planargraph::DirectedEdge::getFromNode
Node * getFromNode() const
Returns the node from which this DirectedEdge leaves.
geos::planargraph::GraphComponent
The base class for all graph component classes.
Definition: planargraph/GraphComponent.h:45
geos::planargraph::DirectedEdge::toEdges
static std::vector< Edge * > * toEdges(std::vector< DirectedEdge * > &dirEdges)
Returns a List containing the parent Edge (possibly null) for each of the given DirectedEdges.
geos::planargraph::DirectedEdge::getQuadrant
int getQuadrant() const
Returns 0, 1, 2, or 3, indicating the quadrant in which this DirectedEdge's orientation lies.
geos::planargraph::DirectedEdge::getEdge
Edge * getEdge() const
Returns this DirectedEdge's parent Edge, or null if it has none.
geos::planargraph::DirectedEdge::getAngle
double getAngle() const
Returns the angle that the start of this DirectedEdge makes with the positive x-axis,...
geos::geom::Coordinate
Coordinate is the lightweight class used to store coordinates.
Definition: Coordinate.h:216
geos::planargraph::DirectedEdge::compareTo
int compareTo(const DirectedEdge *obj) const
Returns 1 if this DirectedEdge has a greater angle with the positive x-axis than b",...
geos::planargraph::DirectedEdge::print
std::string print() const
Prints a detailed string representation of this DirectedEdge to the given PrintStream.
geos::planargraph::operator<<
std::ostream & operator<<(std::ostream &, const DirectedEdge &)
Output operator.
geos::planargraph::Node
A node in a PlanarGraph is a location where 0 or more Edge meet.
Definition: planargraph/Node.h:44
geos::planargraph::DirectedEdge::DirectedEdge
DirectedEdge(Node *newFrom, Node *newTo, const geom::Coordinate &directionPt, bool newEdgeDirection)
Constructs a DirectedEdge connecting the from node to the to node.
geos::planargraph::Edge
Represents an undirected edge of a PlanarGraph.
Definition: planargraph/Edge.h:54
geos::planargraph::DirectedEdge::getCoordinate
geom::Coordinate & getCoordinate() const
Returns the coordinate of the from-node.
geos::planargraph::DirectedEdge::setSym
void setSym(DirectedEdge *newSym)
Sets this DirectedEdge's symmetric DirectedEdge, which runs in the opposite direction.
geos::planargraph::DirectedEdge::getSym
DirectedEdge * getSym() const
Returns the symmetric DirectedEdge – the other DirectedEdge associated with this DirectedEdge's paren...
geos::planargraph::DirectedEdge::toEdges
static void toEdges(std::vector< DirectedEdge * > &dirEdges, std::vector< Edge * > &parentEdges)
Add parent Edge (possibly null) of each of the given DirectedEdges to the given parentEdges vector.
geos::planargraph::DirectedEdge::getToNode
Node * getToNode() const
Returns the node to which this DirectedEdge goes.