SUMO - Simulation of Urban MObility
Boundary Class Reference

A class that stores a 2D geometrical boundary. More...

#include <Boundary.h>

Inheritance diagram for Boundary:
Inheritance graph
Collaboration diagram for Boundary:
Collaboration graph

Public Member Functions

void add (double x, double y, double z=0)
 Makes the boundary include the given coordinate. More...
 
void add (const Position &p)
 Makes the boundary include the given coordinate. More...
 
void add (const Boundary &p)
 Makes the boundary include the given boundary. More...
 
 Boundary ()
 Constructor - the boundary is unset. More...
 
 Boundary (double x1, double y1, double x2, double y2)
 Constructor - the boundary will be build using the given values. More...
 
 Boundary (double x1, double y1, double z1, double x2, double y2, double z2)
 Constructor - the boundary will be build using the given values including Z. More...
 
double distanceTo2D (const Position &p) const
 returns the euclidean distance in the x-y-plane More...
 
double distanceTo2D (const Boundary &b) const
 returns the euclidean distance in the x-y-plane More...
 
void flipY ()
 flips ymin and ymax More...
 
Position getCenter () const
 Returns the center of the boundary. More...
 
double getHeight () const
 Returns the height of the boundary (y-axis) More...
 
double getWidth () const
 Returns the width of the boudary (x-axis) More...
 
double getZRange () const
 Returns the elevation range of the boundary (z-axis) More...
 
Boundarygrow (double by)
 extends the boundary by the given amount More...
 
void growHeight (double by)
 Increases the height of the boundary (y-axis) More...
 
void growWidth (double by)
 Increases the width of the boundary (x-axis) More...
 
bool isInitialised () const
 check if Boundary is Initialised More...
 
void moveby (double x, double y, double z=0)
 Moves the boundary by the given amount. More...
 
bool operator!= (const Boundary &b) const
 Comparison operator not equal. More...
 
bool operator== (const Boundary &b) const
 Comparison operator equal. More...
 
void reset ()
 Resets the boundary. More...
 
void set (double xmin, double ymin, double xmax, double ymax)
 Sets the boundary to the given values. More...
 
double xmax () const
 Returns maximum x-coordinate. More...
 
double xmin () const
 Returns minimum x-coordinate. More...
 
double ymax () const
 Returns maximum y-coordinate. More...
 
double ymin () const
 Returns minimum y-coordinate. More...
 
double zmax () const
 Returns maximum z-coordinate. More...
 
double zmin () const
 Returns minimum z-coordinate. More...
 
 ~Boundary ()
 Destructor. More...
 
inherited from AbstractPoly

Returns whether the boundary contains the given coordinate

bool around (const Position &p, double offset=0) const
 Returns whether the AbstractPoly the given coordinate. More...
 
bool overlapsWith (const AbstractPoly &poly, double offset=0) const
 Returns whether the boundary overlaps with the given polygon. More...
 
bool partialWithin (const AbstractPoly &poly, double offset=0) const
 Returns whether the boundary is partially within the given polygon. More...
 
bool crosses (const Position &p1, const Position &p2) const
 Returns whether the boundary crosses the given line. More...
 

Private Attributes

bool myWasInitialised
 Information whether the boundary was initialised. More...
 
double myXmax
 
double myXmin
 The boundaries. More...
 
double myYmax
 
double myYmin
 
double myZmax
 
double myZmin
 

Friends

std::ostream & operator<< (std::ostream &os, const Boundary &b)
 Output operator. More...
 

Detailed Description

A class that stores a 2D geometrical boundary.

Definition at line 42 of file Boundary.h.

Constructor & Destructor Documentation

◆ Boundary() [1/3]

Boundary::Boundary ( )

Constructor - the boundary is unset.

Definition at line 36 of file Boundary.cpp.

◆ Boundary() [2/3]

Boundary::Boundary ( double  x1,
double  y1,
double  x2,
double  y2 
)

Constructor - the boundary will be build using the given values.

Definition at line 43 of file Boundary.cpp.

References add().

◆ Boundary() [3/3]

Boundary::Boundary ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2 
)

Constructor - the boundary will be build using the given values including Z.

Definition at line 53 of file Boundary.cpp.

References add().

◆ ~Boundary()

Boundary::~Boundary ( )

Destructor.

Definition at line 63 of file Boundary.cpp.

Member Function Documentation

◆ add() [1/3]

void Boundary::add ( double  x,
double  y,
double  z = 0 
)

Makes the boundary include the given coordinate.

Definition at line 79 of file Boundary.cpp.

References myWasInitialised, myXmax, myXmin, myYmax, myYmin, myZmax, and myZmin.

Referenced by add(), NIVissimConnectionCluster::NodeSubCluster::add(), NIVissimConnectionCluster::add(), GUIParkingArea::addLotEntry(), ROEdge::addSuccessor(), MSEdge::addSuccessor(), Boundary(), GUIDanielPerspectiveChanger::centerTo(), NBNetBuilder::compute(), GNENet::computeAndUpdate(), NIVissimDisturbance::computeBounding(), NIVissimConnection::computeBounding(), GUIEdge::getBoundary(), GNEEdge::getBoundary(), MSDevice_BTsender::VehicleInformation::getBoxBoundary(), PositionVector::getBoxBoundary(), GUITrafficLightLogicWrapper::getCenteringBoundary(), GUIPolygon::getCenteringBoundary(), GUIContainer::getCenteringBoundary(), GUIPerson::getCenteringBoundary(), GUIPointOfInterest::getCenteringBoundary(), GUIBusStop::getCenteringBoundary(), GUIBaseVehicle::getCenteringBoundary(), GUILane::getCenteringBoundary(), GUISUMOAbstractView::getGUIGlObjectsAtPosition(), GUISUMOAbstractView::getObjectAtPosition(), GUISUMOAbstractView::getObjectsAtPosition(), GUICalibrator::GUICalibrator(), GUILaneSpeedTrigger::GUILaneSpeedTrigger(), GUITriggeredRerouter::GUITriggeredRerouter(), GUITriggeredRerouter::GUITriggeredRerouterEdge::GUITriggeredRerouterEdge(), MSPModel_Remote::handleShape(), GUINet::initGUIStructures(), GNENet::initJunctionsAndEdges(), NBHeightMapper::loadShapeFile(), NBHeightMapper::loadTiff(), GNEViewNet::mergeJunctions(), NIImporter_OpenDrive::myCharacters(), GUITriggeredRerouter::myEndElement(), GUIMEInductLoop::MyWrapper::MyWrapper(), GUIInstantInductLoop::MyWrapper::MyWrapper(), GUIE3Collector::MyWrapper::MyWrapper(), GUIInductLoop::MyWrapper::MyWrapper(), GNEPolygonFrame::GEOPOICreator::onCmdCreateGEOPOI(), GNEViewNet::SelectingArea::processEdgeRectangleSelection(), GNEViewNet::SelectingArea::processRectangleSelection(), NIVissimConnectionCluster::recomputeBoundary(), GNENet::registerEdge(), GNENet::registerJunction(), ROEdge::ROEdge(), MSEdge::setJunctions(), GUIDanielPerspectiveChanger::setViewport(), GNEJunction::updateGeometry(), and GeoConvHelper::x2cartesian().

◆ add() [2/3]

void Boundary::add ( const Position p)

Makes the boundary include the given coordinate.

Definition at line 100 of file Boundary.cpp.

References add(), Position::x(), Position::y(), and Position::z().

◆ add() [3/3]

void Boundary::add ( const Boundary p)

Makes the boundary include the given boundary.

Definition at line 106 of file Boundary.cpp.

References add(), xmax(), xmin(), ymax(), ymin(), zmax(), and zmin().

◆ around()

bool Boundary::around ( const Position p,
double  offset = 0 
) const
virtual

◆ crosses()

bool Boundary::crosses ( const Position p1,
const Position p2 
) const
virtual

Returns whether the boundary crosses the given line.

Implements AbstractPoly.

Definition at line 203 of file Boundary.cpp.

References PositionVector::intersects(), myXmax, myXmin, myYmax, and myYmin.

◆ distanceTo2D() [1/2]

double Boundary::distanceTo2D ( const Position p) const

returns the euclidean distance in the x-y-plane

Definition at line 223 of file Boundary.cpp.

References myXmax, myXmin, myYmax, myYmin, Position::x(), and Position::y().

Referenced by ROEdge::getDistanceTo(), and MSEdge::getDistanceTo().

◆ distanceTo2D() [2/2]

double Boundary::distanceTo2D ( const Boundary b) const

returns the euclidean distance in the x-y-plane

Definition at line 257 of file Boundary.cpp.

References myXmax, myXmin, myYmax, and myYmin.

◆ flipY()

void Boundary::flipY ( )

flips ymin and ymax

Definition at line 323 of file Boundary.cpp.

References myYmax, and myYmin.

Referenced by GeoConvHelper::computeFinal().

◆ getCenter()

◆ getHeight()

◆ getWidth()

◆ getZRange()

double Boundary::getZRange ( ) const

Returns the elevation range of the boundary (z-axis)

Definition at line 167 of file Boundary.cpp.

References myZmax, and myZmin.

Referenced by NBNetBuilder::compute().

◆ grow()

Boundary & Boundary::grow ( double  by)

extends the boundary by the given amount

Returns
a reference to the instance for further use

Definition at line 301 of file Boundary.cpp.

References myXmax, myXmin, myYmax, and myYmin.

Referenced by GUIParkingArea::addLotEntry(), GUIDanielPerspectiveChanger::centerTo(), NBEdgeCont::checkOverlap(), libsumo::Helper::collectObjectsInRange(), MSDevice_BTreceiver::BTreceiverUpdate::execute(), MSLane::fill(), GUIEdge::getBoundary(), GNEEdge::getBoundary(), GNEJunction::getCenteringBoundary(), GNECrossing::getCenteringBoundary(), GNEInternalLane::getCenteringBoundary(), GUITrafficLightLogicWrapper::getCenteringBoundary(), GUILaneSpeedTrigger::getCenteringBoundary(), GUIPolygon::getCenteringBoundary(), GUIInstantInductLoop::MyWrapper::getCenteringBoundary(), GUICalibrator::getCenteringBoundary(), GUIContainer::getCenteringBoundary(), GUIPerson::getCenteringBoundary(), GUIJunctionWrapper::getCenteringBoundary(), GUIMEInductLoop::MyWrapper::getCenteringBoundary(), GUIPointOfInterest::getCenteringBoundary(), GNELane::getCenteringBoundary(), GUIE3Collector::MyWrapper::getCenteringBoundary(), GNEConnection::getCenteringBoundary(), GUITriggeredRerouter::getCenteringBoundary(), GUIChargingStation::getCenteringBoundary(), GUIContainerStop::getCenteringBoundary(), GUIBusStop::getCenteringBoundary(), GUIEdge::getCenteringBoundary(), GUIE2Collector::MyWrapper::getCenteringBoundary(), GUIBaseVehicle::getCenteringBoundary(), GUIInductLoop::MyWrapper::getCenteringBoundary(), GUITriggeredRerouter::GUITriggeredRerouterEdge::getCenteringBoundary(), GNEEdge::getCenteringBoundary(), GUILane::getCenteringBoundary(), GNEAdditional::getCenteringBoundary(), GUISUMOAbstractView::getGUIGlObjectsAtPosition(), GUISUMOAbstractView::getObjectAtPosition(), GUISUMOAbstractView::getObjectsAtPosition(), GUIParkingArea::GUIParkingArea(), NBEdgeCont::ignoreFilterMatch(), GUINet::initGUIStructures(), GNEViewNet::mergeJunctions(), and GNEPolygonFrame::GEOPOICreator::onCmdCreateGEOPOI().

◆ growHeight()

void Boundary::growHeight ( double  by)

Increases the height of the boundary (y-axis)

Definition at line 317 of file Boundary.cpp.

References myYmax, and myYmin.

Referenced by GUIPointOfInterest::getCenteringBoundary(), GUIPerspectiveChanger::patchedViewPort(), and GUIDanielPerspectiveChanger::setViewport().

◆ growWidth()

void Boundary::growWidth ( double  by)

Increases the width of the boundary (x-axis)

Definition at line 310 of file Boundary.cpp.

References myXmax, and myXmin.

Referenced by GUIPointOfInterest::getCenteringBoundary(), GUIPerspectiveChanger::patchedViewPort(), and GUIDanielPerspectiveChanger::setViewport().

◆ isInitialised()

◆ moveby()

void Boundary::moveby ( double  x,
double  y,
double  z = 0 
)

◆ operator!=()

bool Boundary::operator!= ( const Boundary b) const

Comparison operator not equal.

Definition at line 354 of file Boundary.cpp.

◆ operator==()

bool Boundary::operator== ( const Boundary b) const

Comparison operator equal.

Definition at line 341 of file Boundary.cpp.

References myWasInitialised, myXmax, myXmin, myYmax, myYmin, myZmax, and myZmin.

◆ overlapsWith()

bool Boundary::overlapsWith ( const AbstractPoly poly,
double  offset = 0 
) const
virtual

◆ partialWithin()

bool Boundary::partialWithin ( const AbstractPoly poly,
double  offset = 0 
) const
virtual

Returns whether the boundary is partially within the given polygon.

Implements AbstractPoly.

Definition at line 291 of file Boundary.cpp.

References AbstractPoly::around(), myXmax, myXmin, myYmax, and myYmin.

Referenced by PCPolyContainer::add(), and overlapsWith().

◆ reset()

◆ set()

void Boundary::set ( double  xmin,
double  ymin,
double  xmax,
double  ymax 
)

Sets the boundary to the given values.

Definition at line 360 of file Boundary.cpp.

References myXmax, myXmin, myYmax, myYmin, xmax(), xmin(), ymax(), and ymin().

◆ xmax()

double Boundary::xmax ( ) const

Returns maximum x-coordinate.

Definition at line 125 of file Boundary.cpp.

References myXmax.

Referenced by add(), NIVissimConnectionCluster::add(), SUMORTree::addAdditionalGLObject(), NBHeightMapper::addTriangle(), GUISUMOAbstractView::applyGLTransform(), NIVissimConnectionCluster::around(), NIVissimConnection::buildNodeClusters(), GUIDanielPerspectiveChanger::changeCanvasSizeLeft(), libsumo::Helper::collectObjectsInRange(), NBNetBuilder::compute(), NIVissimDisturbance::computeBounding(), NIVissimBoundedClusterObject::crosses(), GeomHelper::crossPoint(), GUIViewTraffic::doPaintGL(), GNEViewNet::doPaintGL(), MSDevice_BTreceiver::BTreceiverUpdate::execute(), MSLane::fill(), NBPTStopCont::findAccessEdgesForRailStops(), NIVissimConnection::getBoundingBox(), libsumo::Simulation::getNetBoundary(), NIVissimConnectionCluster::getPositionForEdge(), libsumo::Junction::getTree(), libsumo::Polygon::getTree(), NBHeightMapper::getZ(), GUINet::initGUIStructures(), MSPModel_Remote::initialize(), main(), GUISUMOAbstractView::makeSnapshot(), NIVissimConnectionCluster::NIVissimConnectionCluster(), NIVissimConnectionCluster::overlapsWith(), NIVissimConnectionCluster::NodeSubCluster::overlapsWith(), GUISUMOAbstractView::paintGLGrid(), TraCIServerAPI_GUI::processGet(), NIVissimConnectionCluster::recheckEdges(), NIVissimConnectionCluster::recomputeBoundary(), SUMORTree::removeAdditionalGLObject(), set(), GUIBaseVehicle::setFunctionalColor(), GNEPoly::simplifyShape(), BinaryFormatter::writeAttr(), NWWriter_OpenDrive::writeNetwork(), NWWriter_DlrNavteq::writeNodesUnsplitted(), and GUIDanielPerspectiveChanger::zoom().

◆ xmin()

double Boundary::xmin ( ) const

Returns minimum x-coordinate.

Definition at line 119 of file Boundary.cpp.

References myXmin.

Referenced by add(), NIVissimConnectionCluster::add(), SUMORTree::addAdditionalGLObject(), NBHeightMapper::addTriangle(), GUISUMOAbstractView::applyGLTransform(), NIVissimConnectionCluster::around(), NIVissimConnection::buildNodeClusters(), GUIDanielPerspectiveChanger::changeCanvasSizeLeft(), libsumo::Helper::collectObjectsInRange(), NBNetBuilder::compute(), NIVissimDisturbance::computeBounding(), NIVissimBoundedClusterObject::crosses(), GeomHelper::crossPoint(), GUIViewTraffic::doPaintGL(), GNEViewNet::doPaintGL(), MSDevice_BTreceiver::BTreceiverUpdate::execute(), MSLane::fill(), NBPTStopCont::findAccessEdgesForRailStops(), NIVissimConnection::getBoundingBox(), libsumo::Simulation::getNetBoundary(), NIVissimConnectionCluster::getPositionForEdge(), libsumo::Junction::getTree(), libsumo::Polygon::getTree(), NBHeightMapper::getZ(), GUINet::initGUIStructures(), MSPModel_Remote::initialize(), main(), GUISUMOAbstractView::makeSnapshot(), NBNetBuilder::moveToOrigin(), NIVissimConnectionCluster::NIVissimConnectionCluster(), NIVissimConnectionCluster::overlapsWith(), NIVissimConnectionCluster::NodeSubCluster::overlapsWith(), GUISUMOAbstractView::paintGLGrid(), TraCIServerAPI_GUI::processGet(), NIVissimConnectionCluster::recheckEdges(), NIVissimConnectionCluster::recomputeBoundary(), SUMORTree::removeAdditionalGLObject(), GUISUMOAbstractView::screenPos2NetPos(), set(), GUIBaseVehicle::setFunctionalColor(), GNEPoly::simplifyShape(), BinaryFormatter::writeAttr(), NWWriter_OpenDrive::writeNetwork(), NWWriter_DlrNavteq::writeNodesUnsplitted(), and GUIDanielPerspectiveChanger::zoom().

◆ ymax()

◆ ymin()

◆ zmax()

double Boundary::zmax ( ) const

Returns maximum z-coordinate.

Definition at line 149 of file Boundary.cpp.

References myZmax.

Referenced by add(), and libsumo::Simulation::getNetBoundary().

◆ zmin()

double Boundary::zmin ( ) const

Returns minimum z-coordinate.

Definition at line 143 of file Boundary.cpp.

References myZmin.

Referenced by add(), and libsumo::Simulation::getNetBoundary().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Boundary b 
)
friend

Output operator.

Definition at line 334 of file Boundary.cpp.

Field Documentation

◆ myWasInitialised

bool Boundary::myWasInitialised
private

Information whether the boundary was initialised.

Definition at line 156 of file Boundary.h.

Referenced by add(), isInitialised(), operator==(), and reset().

◆ myXmax

double Boundary::myXmax
private

◆ myXmin

double Boundary::myXmin
private

◆ myYmax

◆ myYmin

◆ myZmax

double Boundary::myZmax
private

Definition at line 153 of file Boundary.h.

Referenced by add(), around(), getCenter(), getZRange(), moveby(), operator==(), reset(), and zmax().

◆ myZmin

double Boundary::myZmin
private

Definition at line 153 of file Boundary.h.

Referenced by add(), around(), getCenter(), getZRange(), moveby(), operator==(), reset(), and zmin().


The documentation for this class was generated from the following files: