CircularArc.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2024-2025 ISciences, LLC
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation.
 * See the COPYING file for more information.
 *
 **********************************************************************/
 
#pragma once
 
#include <geos/export.h>
#include <geos/geom/Coordinate.h>
#include <geos/geom/LineSegment.h>
#include <geos/geom/Quadrant.h>
#include <geos/algorithm/CircularArcs.h>
#include <geos/algorithm/Orientation.h>
 
// Forward declarations
namespace geos::algorithm {
class CurveToLineParams;
}
 
namespace geos {
namespace geom {
 
class GEOS_DLL CircularArc {
public:
 
    CircularArc();
 
    CircularArc(const CoordinateSequence&, std::size_t pos);
    CircularArc(const CoordinateSequence&, std::size_t pos, const CoordinateXY& center, double radius, int orientation);
 
    CircularArc(std::unique_ptr<CoordinateSequence>, std::size_t pos);
    CircularArc(std::unique_ptr<CoordinateSequence>, std::size_t pos, const CoordinateXY& center, double radius, int orientation);
 
    CircularArc(const CircularArc& other);
 
    CircularArc(CircularArc&&) noexcept;
 
    CircularArc& operator=(const CircularArc& other);
    CircularArc& operator=(CircularArc&&) noexcept;
 
    ~CircularArc();
 
    template<typename CoordType>
    static CircularArc create(const CoordType& p0, const CoordType& p1, const CoordType& p2)
    {
        auto seq = std::make_unique<CoordinateSequence>(3, CoordType::template has<Ordinate::Z>(), CoordType::template has<Ordinate::M>());
        seq->setAt(p0, 0);
        seq->setAt(p1, 1);
        seq->setAt(p2, 2);
 
        CircularArc ret(std::move(seq), 0);
 
        return ret;
    }
 
    static CircularArc create(const CoordinateXY& p0, const CoordinateXY& p2, const CoordinateXY& center, double radius, int orientation);
    static CircularArc create(const Coordinate& p0, const Coordinate& p2, const CoordinateXY& center, double radius, int orientation);
    static CircularArc create(const CoordinateXYM& p0, const CoordinateXYM& p2, const CoordinateXY& center, double radius, int orientation);
    static CircularArc create(const CoordinateXYZM& p0, const CoordinateXYZM& p2, const CoordinateXY& center, double radius, int orientation);
 
    double getAngle() const;
 
    double getArea() const;
 
    const CoordinateXY& getCenter() const {
        if (!m_center_known) {
            if (isCCW()) {
                m_center = algorithm::CircularArcs::getCenter(p0(), p1(), p2());
            } else {
                m_center = algorithm::CircularArcs::getCenter(p2(), p1(), p0());
            }
            m_center_known = true;
        }
 
        return m_center;
    }
 
    const CoordinateSequence* getCoordinateSequence() const {
        return m_seq;
    }
 
    std::size_t getCoordinatePosition() const {
        return m_pos;
    }
 
    CoordinateXY getDirectionPoint() const;
 
    CoordinateXY getReverseDirectionPoint() const;
 
    Envelope getEnvelope() const;
 
    double getLength() const;
 
    void addLinearizedPoints(CoordinateSequence& seq, const algorithm::CurveToLineParams& params) const;
 
    int getOrientation() const {
        if (!m_orientation_known) {
            m_orientation = algorithm::Orientation::index(p0(), p1(), p2());
            m_orientation_known = true;
        }
        return m_orientation;
    }
 
    double getRadius() const {
        if (!m_radius_known) {
            if (isCCW()) {
                m_radius = getCenter().distance(p0());
            } else {
                m_radius = getCenter().distance(p2());
            }
            m_radius_known = true;
        }
 
        return m_radius;
    }
 
    double getSagitta() const {
        CoordinateXY midpoint = algorithm::CircularArcs::getMidpoint(p0(), p2(), getCenter(), getRadius(), isCCW());
        return algorithm::Distance::pointToSegment(midpoint, p0(), p2());
    }
 
    bool isCCW() const {
        return getOrientation() == algorithm::Orientation::COUNTERCLOCKWISE;
    }
 
    bool isCircle() const {
        return p0().equals(p2());
    }
 
    bool isLinear() const {
        return !std::isfinite(getRadius());
    }
 
    double theta0() const {
        return algorithm::CircularArcs::getAngle(p0(), getCenter());
    }
 
    double theta1() const {
        return algorithm::CircularArcs::getAngle(p1(), getCenter());
    }
 
    double theta2() const {
        return algorithm::CircularArcs::getAngle(p2(), getCenter());
    }
    bool containsAngle(double theta) const;
 
    bool containsPoint(const CoordinateXY& q) const;
 
    bool containsPointOnCircle(const CoordinateXY& q) const {
        double theta = std::atan2(q.y - getCenter().y, q.x - getCenter().x);
        return containsAngle(theta);
    }
 
    CoordinateXY closestPoint(const CoordinateXY& p) const;
    std::array<CoordinateXY, 2> closestPoints(const CoordinateXY& p1, const CoordinateXY& p2) const;
    std::array<CoordinateXY, 2> closestPoints(const CircularArc& other) const;
 
    double distance(const CoordinateXY& p) const;
    double distance(const CoordinateXY& p1, const CoordinateXY& p2) const;
    double distance(const CircularArc& other) const;
 
    CircularArc reverse() const;
 
    // Split an arc at a specified point.
    // The point is assumed to be on the arc.
    //std::pair<CircularArc, CircularArc> splitAtPoint(const CoordinateXY& q) const;
 
    bool equals(const CircularArc& other, double tol) const;
 
    class Iterator {
    public:
        using iterator_category = std::forward_iterator_tag;
        using difference_type = std::ptrdiff_t;
        using value_type = geom::CoordinateXY;
        using pointer = const geom::CoordinateXY*;
        using reference = const geom::CoordinateXY&;
 
        Iterator(const CircularArc& arc, int i) : m_arc(arc), m_i(i) {}
 
        reference operator*() const {
            return m_i == 0 ? m_arc.p0() : (m_i == 1 ? m_arc.p1() : m_arc.p2());
        }
 
        Iterator& operator++() {
            m_i++;
            return *this;
        }
 
        Iterator operator++(int) {
            Iterator ret = *this;
            m_i++;
            return ret;
        }
 
        bool operator==(const Iterator& other) const {
            return m_i == other.m_i;
        }
 
        bool operator!=(const Iterator& other) const {
            return !(*this == other);
        }
 
    private:
        const CircularArc& m_arc;
        int m_i;
 
    };
 
    Iterator begin() const {
        return Iterator(*this, 0);
    }
 
    Iterator end() const {
        return Iterator(*this, 3);
    }
 
    template<typename T=CoordinateXY>
    const T& p0() const {
        return m_seq->getAt<T>(m_pos);
    }
 
    template<typename T=CoordinateXY>
    const T& p1() const {
        return m_seq->getAt<T>(m_pos + 1);
    }
 
    template<typename T=CoordinateXY>
    const T& p2() const {
        return m_seq->getAt<T>(m_pos + 2);
    }
 
    std::string toString() const;
 
    template<typename F>
    auto applyAt(std::size_t i, F&& f) const {
        return m_seq->applyAt(m_pos + i, f);
    }
 
private:
    const CoordinateSequence* m_seq;
    std::size_t m_pos;
 
    mutable CoordinateXY m_center;
    mutable double m_radius;
    mutable int m_orientation;
    mutable bool m_center_known = false;
    mutable bool m_radius_known = false;
    mutable bool m_orientation_known = false;
    bool m_own_coordinates;
};
 
}
}