Represents a directed edge in a PlanarGraph.
More...
#include <DirectedEdge.h>
|
| | DirectedEdge (Node *newFrom, Node *newTo, const geom::Coordinate &directionPt, bool newEdgeDirection) |
| | Constructs a DirectedEdge connecting the from node to the to node. More...
|
| |
| Edge * | getEdge () const |
| | Returns this DirectedEdge's parent Edge, or null if it has none. More...
|
| |
| void | setEdge (Edge *newParentEdge) |
| | Associates this DirectedEdge with an Edge (possibly null, indicating no associated Edge). More...
|
| |
| int | getQuadrant () const |
| | Returns 0, 1, 2, or 3, indicating the quadrant in which this DirectedEdge's orientation lies. More...
|
| |
| const geom::Coordinate & | getDirectionPt () const |
| | Returns a point to which an imaginary line is drawn from the from-node to specify this DirectedEdge's orientation. More...
|
| |
| bool | getEdgeDirection () const |
| | Returns whether the direction of the parent Edge (if any) is the same as that of this Directed Edge. More...
|
| |
| Node * | getFromNode () const |
| | Returns the node from which this DirectedEdge leaves. More...
|
| |
| Node * | getToNode () const |
| | Returns the node to which this DirectedEdge goes. More...
|
| |
| geom::Coordinate & | getCoordinate () const |
| | Returns the coordinate of the from-node. More...
|
| |
| double | getAngle () const |
| | Returns the angle that the start of this DirectedEdge makes with the positive x-axis, in radians. More...
|
| |
| DirectedEdge * | getSym () const |
| | Returns the symmetric DirectedEdge – the other DirectedEdge associated with this DirectedEdge's parent Edge. More...
|
| |
| void | setSym (DirectedEdge *newSym) |
| | Sets this DirectedEdge's symmetric DirectedEdge, which runs in the opposite direction. More...
|
| |
| int | compareTo (const DirectedEdge *obj) const |
| | Returns 1 if this DirectedEdge has a greater angle with the positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise. More...
|
| |
| int | compareDirection (const DirectedEdge *e) const |
| | Returns 1 if this DirectedEdge has a greater angle with the positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise. More...
|
| |
| std::string | print () const |
| | Prints a detailed string representation of this DirectedEdge to the given PrintStream. More...
|
| |
| | GraphComponent () |
| |
| virtual | ~GraphComponent () |
| |
| virtual bool | isVisited () const |
| | Tests if a component has been visited during the course of a graph algorithm. More...
|
| |
| virtual void | setVisited (bool p_isVisited) |
| | Sets the visited flag for this component. More...
|
| |
| virtual bool | isMarked () const |
| | Tests if a component has been marked at some point during the processing involving this graph. More...
|
| |
| virtual void | setMarked (bool p_isMarked) |
| | Sets the marked flag for this component. More...
|
| |
|
| static std::vector< Edge * > * | toEdges (std::vector< DirectedEdge * > &dirEdges) |
| | Returns a List containing the parent Edge (possibly null) for each of the given DirectedEdges. More...
|
| |
| 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. More...
|
| |
| template<typename T > |
| static void | setVisited (T start, T end, bool visited) |
| | Sets the Visited state for the elements of a container, from start to end iterator. More...
|
| |
| template<typename T > |
| static void | setVisitedMap (T start, T end, bool visited) |
| | Sets the Visited state for the values of each map container element, from start to end iterator. More...
|
| |
| template<typename T > |
| static void | setMarked (T start, T end, bool marked) |
| | Sets the Marked state for the elements of a container, from start to end iterator. More...
|
| |
| template<typename T > |
| static void | setMarkedMap (T start, T end, bool marked) |
| | Sets the Marked state for the values of each map container element, from start to end iterator. More...
|
| |
Represents a directed edge in a PlanarGraph.
A DirectedEdge may or may not have a reference to a parent Edge (some applications of planar graphs may not require explicit Edge objects to be created). Usually a client using a PlanarGraph will subclass DirectedEdge to add its own application-specific data and methods.
Definition at line 46 of file planargraph/DirectedEdge.h.
| geos::planargraph::DirectedEdge::DirectedEdge |
( |
Node * |
newFrom, |
|
|
Node * |
newTo, |
|
|
const geom::Coordinate & |
directionPt, |
|
|
bool |
newEdgeDirection |
|
) |
| |
Constructs a DirectedEdge connecting the from node to the to node.
- Parameters
-
| newFrom | from node |
| newTo | to node |
| directionPt | specifies this DirectedEdge's direction (given by an imaginary line from the from node to directionPt) |
| newEdgeDirection | whether this DirectedEdge's direction is the same as or opposite to that of the parent Edge (if any) |
| int geos::planargraph::DirectedEdge::compareDirection |
( |
const DirectedEdge * |
e | ) |
const |
Returns 1 if this DirectedEdge has a greater angle with the positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise.
Using the obvious algorithm of simply computing the angle is not robust, since the angle calculation is susceptible to roundoff. A robust algorithm is:
- first compare the quadrants. If the quadrants are different, it it trivial to determine which std::vector is "greater".
- if the vectors lie in the same quadrant, the robust Orientation::index(Coordinate, Coordinate, Coordinate) function can be used to decide the relative orientation of the vectors.
| int geos::planargraph::DirectedEdge::compareTo |
( |
const DirectedEdge * |
obj | ) |
const |
Returns 1 if this DirectedEdge has a greater angle with the positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise.
Using the obvious algorithm of simply computing the angle is not robust, since the angle calculation is susceptible to roundoff. A robust algorithm is:
- first compare the quadrants. If the quadrants are different, it it trivial to determine which std::vector is "greater".
- if the vectors lie in the same quadrant, the robust Orientation::index(Coordinate, Coordinate, Coordinate) function can be used to decide the relative orientation of the vectors.
| double geos::planargraph::DirectedEdge::getAngle |
( |
| ) |
const |
Returns the angle that the start of this DirectedEdge makes with the positive x-axis, in radians.
Returns the coordinate of the from-node.
| const geom::Coordinate& geos::planargraph::DirectedEdge::getDirectionPt |
( |
| ) |
const |
Returns a point to which an imaginary line is drawn from the from-node to specify this DirectedEdge's orientation.
| Edge* geos::planargraph::DirectedEdge::getEdge |
( |
| ) |
const |
| bool geos::planargraph::DirectedEdge::getEdgeDirection |
( |
| ) |
const |
Returns whether the direction of the parent Edge (if any) is the same as that of this Directed Edge.
| Node* geos::planargraph::DirectedEdge::getFromNode |
( |
| ) |
const |
| int geos::planargraph::DirectedEdge::getQuadrant |
( |
| ) |
const |
Returns 0, 1, 2, or 3, indicating the quadrant in which this DirectedEdge's orientation lies.
| DirectedEdge* geos::planargraph::DirectedEdge::getSym |
( |
| ) |
const |
| Node* geos::planargraph::DirectedEdge::getToNode |
( |
| ) |
const |
| std::string geos::planargraph::DirectedEdge::print |
( |
| ) |
const |
Prints a detailed string representation of this DirectedEdge to the given PrintStream.
| void geos::planargraph::DirectedEdge::setEdge |
( |
Edge * |
newParentEdge | ) |
|
| void geos::planargraph::DirectedEdge::setSym |
( |
DirectedEdge * |
newSym | ) |
|
| static std::vector<Edge*>* geos::planargraph::DirectedEdge::toEdges |
( |
std::vector< DirectedEdge * > & |
dirEdges | ) |
|
|
static |
Returns a List containing the parent Edge (possibly null) for each of the given DirectedEdges.
- Note
- Ownership of the returned vector is left to the caller, see the equivalent function taking a vector reference to avoid this.
| static void geos::planargraph::DirectedEdge::toEdges |
( |
std::vector< DirectedEdge * > & |
dirEdges, |
|
|
std::vector< Edge * > & |
parentEdges |
|
) |
| |
|
static |
Add parent Edge (possibly null) of each of the given DirectedEdges to the given parentEdges vector.
- Note
- Parents are pushed to the parentEdges vector, make sure it is empty if index-based corrispondence is important.
| std::ostream& operator<< |
( |
std::ostream & |
, |
|
|
const DirectedEdge & |
|
|
) |
| |
|
friend |
| double geos::planargraph::DirectedEdge::angle |
|
protected |
| bool geos::planargraph::DirectedEdge::edgeDirection |
|
protected |
| Node* geos::planargraph::DirectedEdge::from |
|
protected |
| Edge* geos::planargraph::DirectedEdge::parentEdge |
|
protected |
| int geos::planargraph::DirectedEdge::quadrant |
|
protected |
| Node* geos::planargraph::DirectedEdge::to |
|
protected |
The documentation for this class was generated from the following file:
Public Member Functions inherited from geos::planargraph::GraphComponent