lsst.sphgeom gbd998247f1+585e252eca
Loading...
Searching...
No Matches
ConvexPolygon.h
Go to the documentation of this file.
1/*
2 * This file is part of sphgeom.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (http://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This software is dual licensed under the GNU General Public License and also
11 * under a 3-clause BSD license. Recipients may choose which of these licenses
12 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
13 * respectively. If you choose the GPL option then the following text applies
14 * (but note that there is still no warranty even if you opt for BSD instead):
15 *
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 */
29
30#ifndef LSST_SPHGEOM_CONVEXPOLYGON_H_
31#define LSST_SPHGEOM_CONVEXPOLYGON_H_
32
36
37#include <iosfwd>
38#include <vector>
39
40#include "Region.h"
41#include "UnitVector3d.h"
42
43
44namespace lsst {
45namespace sphgeom {
46
64class ConvexPolygon : public Region {
65public:
66 static constexpr uint8_t TYPE_CODE = 'p';
67
72 static ConvexPolygon convexHull(std::vector<UnitVector3d> const & points) {
73 return ConvexPolygon(points);
74 }
75
78 explicit ConvexPolygon(std::vector<UnitVector3d> const & points);
79
85 UnitVector3d const & v1,
86 UnitVector3d const & v2) :
87 _vertices{v0, v1, v2}
88 {}
89
96 UnitVector3d const & v1,
97 UnitVector3d const & v2,
98 UnitVector3d const & v3) :
99 _vertices{v0, v1, v2, v3}
100 {}
101
103 bool operator==(ConvexPolygon const & p) const;
104 bool operator!=(ConvexPolygon const & p) const { return !(*this == p); }
105
106 std::vector<UnitVector3d> const & getVertices() const {
107 return _vertices;
108 }
109
112 UnitVector3d getCentroid() const;
113
114 // Region interface
115 std::unique_ptr<Region> clone() const override {
116 return std::unique_ptr<ConvexPolygon>(new ConvexPolygon(*this));
117 }
118
119 Box getBoundingBox() const override;
120 Box3d getBoundingBox3d() const override;
121 Circle getBoundingCircle() const override;
122
126 bool contains(UnitVector3d const & v) const override;
127 bool contains(Region const & r) const;
129
130 using Region::contains;
131
135 bool isDisjointFrom(Region const & r) const;
137
141 bool intersects(Region const & r) const;
143
147 bool isWithin(Region const & r) const;
149
150 Relationship relate(Region const & r) const override {
151 // Dispatch on the type of r.
152 return invert(r.relate(*this));
153 }
154
155 Relationship relate(Box const &) const override;
156 Relationship relate(Circle const &) const override;
157 Relationship relate(ConvexPolygon const &) const override;
158 Relationship relate(Ellipse const &) const override;
159
160 std::vector<uint8_t> encode() const override;
161
164 static std::unique_ptr<ConvexPolygon> decode(std::vector<uint8_t> const & s) {
165 return decode(s.data(), s.size());
166 }
167 static std::unique_ptr<ConvexPolygon> decode(uint8_t const * buffer, size_t n);
169
170private:
171 typedef std::vector<UnitVector3d>::const_iterator VertexIterator;
172
173 ConvexPolygon() : _vertices() {}
174
175 std::vector<UnitVector3d> _vertices;
176};
177
178std::ostream & operator<<(std::ostream &, ConvexPolygon const &);
179
180}} // namespace lsst::sphgeom
181
182#endif // LSST_SPHGEOM_CONVEXPOLYGON_H_
This file defines an interface for spherical regions.
This file declares a class for representing unit vectors in ℝ³.
Definition Box3d.h:49
Definition Box.h:61
Definition Circle.h:53
Definition ConvexPolygon.h:64
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2, UnitVector3d const &v3)
Definition ConvexPolygon.h:95
Box3d getBoundingBox3d() const override
getBoundingBox3d returns a 3-dimensional bounding-box for this region.
Definition ConvexPolygon.cc:315
bool intersects(Region const &r) const
Definition ConvexPolygon.cc:331
UnitVector3d getCentroid() const
Definition ConvexPolygon.cc:303
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2)
Definition ConvexPolygon.h:84
bool contains(UnitVector3d const &v) const override
Definition ConvexPolygon.cc:319
bool isDisjointFrom(Region const &r) const
Definition ConvexPolygon.cc:327
static ConvexPolygon convexHull(std::vector< UnitVector3d > const &points)
Definition ConvexPolygon.h:72
Relationship relate(Region const &r) const override
Definition ConvexPolygon.h:150
Circle getBoundingCircle() const override
getBoundingCircle returns a bounding-circle for this region.
Definition ConvexPolygon.cc:307
std::vector< uint8_t > encode() const override
Definition ConvexPolygon.cc:355
Box getBoundingBox() const override
getBoundingBox returns a bounding-box for this region.
Definition ConvexPolygon.cc:311
static std::unique_ptr< ConvexPolygon > decode(std::vector< uint8_t > const &s)
Definition ConvexPolygon.h:164
std::unique_ptr< Region > clone() const override
clone returns a deep copy of this region.
Definition ConvexPolygon.h:115
bool operator==(ConvexPolygon const &p) const
Two convex polygons are equal iff they contain the same points.
Definition ConvexPolygon.cc:268
bool isWithin(Region const &r) const
Definition ConvexPolygon.cc:335
Definition Ellipse.h:177
Definition Region.h:86
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:62
Relationship invert(Relationship r)
Definition Relationship.h:62
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
Definition Relationship.h:42