Region.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_REGION_H_
#define LSST_SPHGEOM_REGION_H_


#include <memory>
#include <vector>

#include "Relationship.h"


namespace lsst {
namespace sphgeom {

// Forward declarations
class Box;
class Box3d;
class Circle;
class ConvexPolygon;
class Ellipse;
class UnitVector3d;

class Region {
public:
    virtual ~Region() {}

    virtual std::unique_ptr<Region> clone() const = 0;

    virtual Box getBoundingBox() const = 0;

    virtual Box3d getBoundingBox3d() const = 0;

    virtual Circle getBoundingCircle() const = 0;

    virtual bool contains(UnitVector3d const &) const = 0;

    virtual Relationship relate(Region const &) const = 0;
    virtual Relationship relate(Box const &) const = 0;
    virtual Relationship relate(Circle const &) const = 0;
    virtual Relationship relate(ConvexPolygon const &) const = 0;
    virtual Relationship relate(Ellipse const &) const = 0;

    virtual std::vector<uint8_t> encode() const = 0;

    static std::unique_ptr<Region> decode(std::vector<uint8_t> const & s) {
        return decode(s.data(), s.size());
    }

    static std::unique_ptr<Region> decode(uint8_t const * buffer, size_t n);
};

}} // namespace lsst::sphgeom

#endif // LSST_SPHGEOM_REGION_H_