ConvexPolygon.h

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2014-2015 AURA/LSST.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <https://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_SPHGEOM_CONVEXPOLYGON_H_
#define LSST_SPHGEOM_CONVEXPOLYGON_H_


#include <iosfwd>
#include <vector>

#include "Region.h"
#include "UnitVector3d.h"


namespace lsst {
namespace sphgeom {

class ConvexPolygon : public Region {
public:
    static constexpr 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));
    }

    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;

    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;

    std::vector<uint8_t> encode() const override;

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

private:
    typedef std::vector<UnitVector3d>::const_iterator VertexIterator;

    ConvexPolygon() : _vertices() {}

    std::vector<UnitVector3d> _vertices;
};

std::ostream & operator<<(std::ostream &, ConvexPolygon const &);

}} // namespace lsst::sphgeom

#endif // LSST_SPHGEOM_CONVEXPOLYGON_H_