lsst.sphgeom gb35d6563ee+62d12e78cb
Loading...
Searching...
No Matches
ConvexPolygon.h
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2014-2015 AURA/LSST.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#ifndef LSST_SPHGEOM_CONVEXPOLYGON_H_
24#define LSST_SPHGEOM_CONVEXPOLYGON_H_
25
29
30#include <iosfwd>
31#include <vector>
32
33#include "Region.h"
34#include "UnitVector3d.h"
35
36
37namespace lsst {
38namespace sphgeom {
39
57class ConvexPolygon : public Region {
58public:
59 static constexpr uint8_t TYPE_CODE = 'p';
60
65 static ConvexPolygon convexHull(std::vector<UnitVector3d> const & points) {
66 return ConvexPolygon(points);
67 }
68
71 explicit ConvexPolygon(std::vector<UnitVector3d> const & points);
72
78 UnitVector3d const & v1,
79 UnitVector3d const & v2) :
80 _vertices{v0, v1, v2}
81 {}
82
89 UnitVector3d const & v1,
90 UnitVector3d const & v2,
91 UnitVector3d const & v3) :
92 _vertices{v0, v1, v2, v3}
93 {}
94
96 bool operator==(ConvexPolygon const & p) const;
97 bool operator!=(ConvexPolygon const & p) const { return !(*this == p); }
98
99 std::vector<UnitVector3d> const & getVertices() const {
100 return _vertices;
101 }
102
105 UnitVector3d getCentroid() const;
106
107 // Region interface
108 std::unique_ptr<Region> clone() const override {
109 return std::unique_ptr<ConvexPolygon>(new ConvexPolygon(*this));
110 }
111
112 Box getBoundingBox() const override;
113 Box3d getBoundingBox3d() const override;
114 Circle getBoundingCircle() const override;
115
119 bool contains(UnitVector3d const & v) const override;
120 bool contains(Region const & r) const;
122
123 using Region::contains;
124
128 bool isDisjointFrom(Region const & r) const;
130
134 bool intersects(Region const & r) const;
136
140 bool isWithin(Region const & r) const;
142
143 Relationship relate(Region const & r) const override {
144 // Dispatch on the type of r.
145 return invert(r.relate(*this));
146 }
147
148 Relationship relate(Box const &) const override;
149 Relationship relate(Circle const &) const override;
150 Relationship relate(ConvexPolygon const &) const override;
151 Relationship relate(Ellipse const &) const override;
152
153 std::vector<uint8_t> encode() const override;
154
157 static std::unique_ptr<ConvexPolygon> decode(std::vector<uint8_t> const & s) {
158 return decode(s.data(), s.size());
159 }
160 static std::unique_ptr<ConvexPolygon> decode(uint8_t const * buffer, size_t n);
162
163private:
164 typedef std::vector<UnitVector3d>::const_iterator VertexIterator;
165
166 ConvexPolygon() : _vertices() {}
167
168 std::vector<UnitVector3d> _vertices;
169};
170
171std::ostream & operator<<(std::ostream &, ConvexPolygon const &);
172
173}} // namespace lsst::sphgeom
174
175#endif // LSST_SPHGEOM_CONVEXPOLYGON_H_
This file defines an interface for spherical regions.
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
Definition: Relationship.h:35
Relationship invert(Relationship r)
Definition: Relationship.h:55
This file declares a class for representing unit vectors in ℝ³.
Definition: Box3d.h:42
Definition: Box.h:54
Definition: Circle.h:46
Definition: ConvexPolygon.h:57
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2, UnitVector3d const &v3)
Definition: ConvexPolygon.h:88
Box3d getBoundingBox3d() const override
getBoundingBox3d returns a 3-dimensional bounding-box for this region.
Definition: ConvexPolygon.cc:308
bool intersects(Region const &r) const
Definition: ConvexPolygon.cc:324
UnitVector3d getCentroid() const
Definition: ConvexPolygon.cc:296
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2)
Definition: ConvexPolygon.h:77
bool contains(UnitVector3d const &v) const override
Definition: ConvexPolygon.cc:312
bool isDisjointFrom(Region const &r) const
Definition: ConvexPolygon.cc:320
static ConvexPolygon convexHull(std::vector< UnitVector3d > const &points)
Definition: ConvexPolygon.h:65
Relationship relate(Region const &r) const override
Definition: ConvexPolygon.h:143
Circle getBoundingCircle() const override
getBoundingCircle returns a bounding-circle for this region.
Definition: ConvexPolygon.cc:300
std::vector< uint8_t > encode() const override
Definition: ConvexPolygon.cc:348
Box getBoundingBox() const override
getBoundingBox returns a bounding-box for this region.
Definition: ConvexPolygon.cc:304
static std::unique_ptr< ConvexPolygon > decode(std::vector< uint8_t > const &s)
Definition: ConvexPolygon.h:157
std::unique_ptr< Region > clone() const override
clone returns a deep copy of this region.
Definition: ConvexPolygon.h:108
bool operator==(ConvexPolygon const &p) const
Two convex polygons are equal iff they contain the same points.
Definition: ConvexPolygon.cc:261
bool isWithin(Region const &r) const
Definition: ConvexPolygon.cc:328
Definition: Ellipse.h:170
Definition: Region.h:79
virtual Relationship relate(Region const &) const =0
virtual bool contains(UnitVector3d const &) const =0
contains tests whether the given unit vector is inside this region.
Definition: UnitVector3d.h:55