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    Bresenham.h
      15             : /// @author  Daniel Krajzewicz
      16             : /// @author  Michael Behrisch
      17             : /// @date    Mon, 17 Dec 2001
      18             : ///
      19             : // A class to realise a uniform n:m - relationship using the
      20             : /****************************************************************************/
      21             : #pragma once
      22             : #include <config.h>
      23             : 
      24             : 
      25             : // ===========================================================================
      26             : // class definitions
      27             : // ===========================================================================
      28             : /**
      29             :  * The class' only static method "execute" obtains a callback object and
      30             :  * performs the computation of the n:m - relationship
      31             :  */
      32             : class Bresenham {
      33             : public:
      34             :     /**
      35             :      * BresenhamCallBack
      36             :      * This class is the base interface-describing class for a callback class
      37             :      * for the bresenham-function.
      38             :      * Derived classes must implement the execute-method which is called
      39             :      * on every bresenham-step
      40             :      */
      41             :     class BresenhamCallBack {
      42             :     public:
      43             :         /** constuctor */
      44      145463 :         BresenhamCallBack() { }
      45             : 
      46             :         /** destructor */
      47             :         virtual ~BresenhamCallBack() { }
      48             : 
      49             :         /** called when a bresenham step has been computed */
      50             :         virtual void execute(const int val1, const int val2) = 0;
      51             :     };
      52             : 
      53             : public:
      54             :     /** compute the bresenham - interpolation between both values
      55             :         the higher number is increased by one for each step while the smaller
      56             :         is increased by smaller/higher.
      57             :         In each step, the callback is executed. */
      58             :     static void compute(BresenhamCallBack* callBack, const int val1, const int val2);
      59             : };