ConvexPolygon.h

Go to the documentation of this file.

/*
 * This file is part of sphgeom.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (http://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This software is dual licensed under the GNU General Public License and also
 * under a 3-clause BSD license. Recipients may choose which of these licenses
 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
 * respectively.  If you choose the GPL option then the following text applies
 * (but note that there is still no warranty even if you opt for BSD instead):
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_SPHGEOM_CONVEXPOLYGON_H_
#define LSST_SPHGEOM_CONVEXPOLYGON_H_

 
#include <iosfwd>
#include <vector>
#include <cstdint>
 
#include "Region.h"
#include "UnitVector3d.h"
 
 
namespace lsst {
namespace sphgeom {

class ConvexPolygon : public Region {
public:
    static constexpr std::uint8_t TYPE_CODE = 'p';

    static ConvexPolygon convexHull(std::vector<UnitVector3d> const & points) {
        return ConvexPolygon(points);
    }

    explicit ConvexPolygon(std::vector<UnitVector3d> const & points);

    ConvexPolygon(UnitVector3d const & v0,
                  UnitVector3d const & v1,
                  UnitVector3d const & v2) :
        _vertices{v0, v1, v2}
    {}

    ConvexPolygon(UnitVector3d const & v0,
                  UnitVector3d const & v1,
                  UnitVector3d const & v2,
                  UnitVector3d const & v3) :
        _vertices{v0, v1, v2, v3}
    {}

    bool operator==(ConvexPolygon const & p) const;
    bool operator!=(ConvexPolygon const & p) const { return !(*this == p); }
 
    std::vector<UnitVector3d> const & getVertices() const {
        return _vertices;
    }

    UnitVector3d getCentroid() const;
 
    // Region interface
    std::unique_ptr<Region> clone() const override {
        return std::unique_ptr<ConvexPolygon>(new ConvexPolygon(*this));
    }
 
    bool isEmpty() const override;
 
    Box getBoundingBox() const override;
    Box3d getBoundingBox3d() const override;
    Circle getBoundingCircle() const override;

    bool contains(UnitVector3d const & v) const override;
    bool contains(Region const & r) const;
 
    using Region::contains;

    bool isDisjointFrom(Region const & r) const;

    bool intersects(Region const & r) const;

    bool isWithin(Region const & r) const;
 
    Relationship relate(Region const & r) const override {
        // Dispatch on the type of r.
        return invert(r.relate(*this));
    }
 
    Relationship relate(Box const &) const override;
    Relationship relate(Circle const &) const override;
    Relationship relate(ConvexPolygon const &) const override;
    Relationship relate(Ellipse const &) const override;
 
    TriState overlaps(Region const& other) const override {
        return other.overlaps(*this);
    }
    TriState overlaps(Box const &) const override;
    TriState overlaps(Circle const &) const override;
    TriState overlaps(ConvexPolygon const &) const override;
    TriState overlaps(Ellipse const &) const override;
 
    std::vector<std::uint8_t> encode() const override;

    static std::unique_ptr<ConvexPolygon> decode(std::vector<std::uint8_t> const & s) {
        return decode(s.data(), s.size());
    }
    static std::unique_ptr<ConvexPolygon> decode(std::uint8_t const * buffer, size_t n);
 
private:
    typedef std::vector<UnitVector3d>::const_iterator VertexIterator;
 
    ConvexPolygon() : _vertices() {}

    std::string toIvoaStcsBody(std::string const & frame = "") const override;
 
    std::vector<UnitVector3d> _vertices;
};
 
std::ostream & operator<<(std::ostream &, ConvexPolygon const &);
 
}} // namespace lsst::sphgeom
 
#endif // LSST_SPHGEOM_CONVEXPOLYGON_H_