Line data    Source code

       1              : /****************************************************************************/
       2              : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
       3              : // Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
       4              : // This program and the accompanying materials are made available under the
       5              : // terms of the Eclipse Public License 2.0 which is available at
       6              : // https://www.eclipse.org/legal/epl-2.0/
       7              : // This Source Code may also be made available under the following Secondary
       8              : // Licenses when the conditions for such availability set forth in the Eclipse
       9              : // Public License 2.0 are satisfied: GNU General Public License, version 2
      10              : // or later which is available at
      11              : // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
      12              : // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
      13              : /****************************************************************************/
      14              : /// @file    AbstractPoly.h
      15              : /// @author  Daniel Krajzewicz
      16              : /// @author  Michael Behrisch
      17              : /// @date    Sept 2002
      18              : ///
      19              : // The base class for polygons
      20              : /****************************************************************************/
      21              : #pragma once
      22              : #include <config.h>
      23              : 
      24              : #include "Position.h"
      25              : 
      26              : 
      27              : // ===========================================================================
      28              : // class definitions
      29              : // ===========================================================================
      30              : /**
      31              :  *
      32              :  */
      33     31648513 : class AbstractPoly {
      34              : public:
      35              :     /// @brief destructor
      36              :     virtual ~AbstractPoly() { }
      37              : 
      38              :     /// @brief Returns whether the AbstractPoly the given coordinate
      39              :     virtual bool around(const Position& p, double offset = 0) const = 0;
      40              : 
      41              :     /// @brief Returns whether the AbstractPoly overlaps with the given polygon
      42              :     virtual bool overlapsWith(const AbstractPoly& poly, double offset = 0) const = 0;
      43              : 
      44              :     /// @brief Returns whether the AbstractPoly is partially within the given polygon
      45              :     virtual bool partialWithin(const AbstractPoly& poly, double offset = 0) const = 0;
      46              : 
      47              :     /// @brief Returns whether the AbstractPoly crosses the given line
      48              :     virtual bool crosses(const Position& p1, const Position& p2) const = 0;
      49              : };