Boundary.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A class that stores a 2D geometrical boundary
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <iostream>
#include <utility>
 
#include "AbstractPoly.h"
#include "PositionVector.h"
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class Boundary : public AbstractPoly {
public:
    Boundary();
 
    Boundary(double x1, double y1, double x2, double y2);
 
    Boundary(double x1, double y1, double z1, double x2, double y2, double z2);
 
    void reset();
 
    void add(double x, double y, double z = 0);
 
    void add(const Position& p);
 
    void add(const Boundary& p);
 
    Position getCenter() const;
 
    double xmin() const;
 
    double xmax() const;
 
    double ymin() const;
 
    double ymax() const;
 
    double zmin() const;
 
    double zmax() const;
 
    double getWidth() const;
 
    double getHeight() const;
 
    double getZRange() const;
 
 
    bool around(const Position& p, double offset = 0) const;
 
    bool around2D(const Position& p, double offset = 0) const;
 
    bool around2D(const double x, const double y) const;
 
    bool overlapsWith(const AbstractPoly& poly, double offset = 0) const;
 
    bool partialWithin(const AbstractPoly& poly, double offset = 0) const;
 
    bool crosses(const Position& p1, const Position& p2) const;
 
 
    bool contains2D(const Boundary& b) const;
 
    bool overlaps2D(const Boundary& b) const;
 
    bool isInitialised() const;
 
    double distanceTo2D(const Position& p) const;
 
    double distanceTo2D(const Boundary& b) const;
 
    Boundary& grow(double by);
 
    Boundary& scale(double by);
 
    void growWidth(double by);
 
    void growHeight(double by);
 
    void flipY();
 
    void set(double xmin, double ymin, double xmax, double ymax);
 
    void setOffsets(double xmin, double ymin, double xmax, double ymax);
 
    void moveby(double x, double y, double z = 0);
 
    PositionVector getShape(const bool closeShape) const;
 
    friend std::ostream& operator<<(std::ostream& os, const Boundary& b);
 
    bool operator==(const Boundary& b) const;
 
    bool operator!=(const Boundary& b) const;
 
private:
    double myXmin, myXmax, myYmin, myYmax, myZmin, myZmax;
 
    bool myWasInitialised;
};