Itasca C++ Interface
Loading...
Searching...
No Matches
extent3.h
Go to the documentation of this file.
1#pragma once
8#include "extent2.h"
9
16template <class T> class Extent3 {
17public:
18 // Creators
20 constexpr Extent3()=default;
21 constexpr Extent3(const Extent3<T> &)=default;
22 constexpr Extent3<T> &operator=(const Extent3 &e)=default;
23
25 Extent3(const T &x1,const T &x2,const T &y1,const T &y2,const T &z1,const T &z2)
26 :tx1_(x1), tx2_(x2), ty1_(y1), ty2_(y2), tz1_(z1), tz2_(z2) { }
28 Extent3(const Vector3<T> &v111,const Vector3<T> &v222)
29 :tx1_(v111.x()), tx2_(v222.x()), ty1_(v111.y()), ty2_(v222.y()), tz1_(v111.z()), tz2_(v222.z()) { }
32 explicit Extent3(const Extent2<T> &r) : tx1_(r.x1()), tx2_(r.x2()), ty1_(r.y1()), ty2_(r.y2()), tz1_(0), tz2_(1) { }
37 // Accessors
39 const T &x1() const { return tx1_; }
41 const T &x2() const { return tx2_; }
43 const T &y1() const { return ty1_; }
45 const T &y2() const { return ty2_; }
47 const T &z1() const { return tz1_; }
49 const T &z2() const { return tz2_; }
51 const T &dof1(uint32 u) const {
52 assert(u<3);
53 switch (u) {
54 case 1: return ty1_;
55 case 2: return tz1_;
56 }
57 return tx1_;
58 }
60 const T &dof2(uint32 u) const {
61 assert(u<3);
62 switch (u) {
63 case 1: return ty2_;
64 case 2: return tz2_;
65 }
66 return tx2_;
67 }
69 T width() const { return (tx2_-tx1_); }
71 T height() const { return (ty2_-ty1_); }
73 T depth() const { return (tz2_-tz1_); }
75 Vector3<T> centroid() const { Vector3<T> v((tx1_+tx2_)/2,(ty1_+ty2_)/2,(tz1_+tz2_)/2); return v; }
77 T volume() const { return (width()*height()*depth()); }
79 T diagonal() const { return (size().mag()); }
82 Vector3<T> corner(uint32 x,uint32 y,uint32 z) const {
83 if (x) {
84 if (y) { if (z) return c222(); else return c221(); }
85 else { if (z) return c212(); else return c211(); }
86 } else {
87 if (y) { if (z) return c122(); else return c121(); }
88 else { if (z) return c112(); else return c111(); }
89 }
90 }
91
92 // Corner functions - returns the 8 corners of the region.
94 Vector3<T> c111() const { Vector3<T> out(tx1_,ty1_,tz1_); return out; }
96 Vector3<T> c121() const { Vector3<T> out(tx1_,ty2_,tz1_); return out; }
98 Vector3<T> c211() const { Vector3<T> out(tx2_,ty1_,tz1_); return out; }
100 Vector3<T> c221() const { Vector3<T> out(tx2_,ty2_,tz1_); return out; }
102 Vector3<T> c112() const { Vector3<T> out(tx1_,ty1_,tz2_); return out; }
104 Vector3<T> c122() const { Vector3<T> out(tx1_,ty2_,tz2_); return out; }
106 Vector3<T> c212() const { Vector3<T> out(tx2_,ty1_,tz2_); return out; }
108 Vector3<T> c222() const { Vector3<T> out(tx2_,ty2_,tz2_); return out; }
110 Vector3<T> lowerBound() const { return c111(); }
112 Vector3<T> upperBound() const { return c222(); }
114 Vector3<T> size() const { Vector3<T> out(width(),height(),depth()); return out; }
115
116 // Comparison Operators
118 bool isEmpty() const { return ( (tx1_>=tx2_) || (ty1_>=ty2_) || (tz1_>=tz2_) ); }
120 bool tolIsEmpty(const double &tol = limits<double>::epsilon() * 100) const { return ( (tx1_ + tol >= tx2_) || (ty1_ + tol >= ty2_) || (tz1_ + tol >= tz2_) ); }
122 bool operator==(const Extent3<T> &c) const {
123 return( (tx1_==c.tx1_)&&(tx2_==c.tx2_)&&(ty1_==c.ty1_)&&(ty2_==c.ty2_)&&(tz1_==c.tz1_)&&(tz2_==c.tz2_) );
124 }
126 bool operator!=(const Extent3<T> &r) const { return !operator==(r); }
128 bool operator<(const Extent3<T> &c) const { return (volume() < c.volume()); }
130 bool operator>(const Extent3<T> &c) const { return (volume() > c.volume()); }
132 bool isIn(const Vector3<T> &v) const {
133 if ( (v.x()>=tx1_) && (v.x()<=tx2_) && (v.y()>=ty1_) && (v.y()<=ty2_) && (v.z()>=tz1_) && (v.z()<=tz2_) ) return true;
134 return false;
135 }
137 bool isIn(const Extent3<T> &c) const {
138 if ( (c.x1()>=tx1_) && (c.x2()<=tx2_) && (c.y1()>=ty1_) && (c.y2()<=ty2_) && (c.z1()>=tz1_) && (c.z2()<=tz2_) ) return true;
139 return false;
140 }
142 bool tolIsIn(const Vector3<T> &v,const T &tol) const {
143 if ( (v.x()>=tx1_-tol) && (v.x()<=tx2_+tol) && (v.y()>=ty1_-tol) && (v.y()<=ty2_+tol) && (v.z()>=tz1_-tol) && (v.z()<=tz2_+tol) ) return true;
144 return false;
145 }
147 bool tolIsIn(const Extent3<T> &c,const T &tol) const {
148 if ( (c.x1()>=tx1_-tol) && (c.x2()<=tx2_+tol) && (c.y1()>=ty1_-tol) && (c.y2()<=ty2_+tol) && (c.z1()>=tz1_-tol) && (c.z2()<=tz2_+tol) ) return true;
149 return false;
150 }
152 bool intersects(const Extent3<T> &c) const {
153 if ((c.tx2_<tx1_) || (c.tx1_>tx2_) ||
154 (c.ty2_<ty1_) || (c.ty1_>ty2_) ||
155 (c.tz2_<tz1_) || (c.tz1_>tz2_)) return false;
156 return true;
157 }
159 bool tolIntersects(const Extent3<T> &c,const T &tol) const {
160 if ((c.tx2_<tx1_-tol) || (c.tx1_>tx2_+tol) ||
161 (c.ty2_<ty1_-tol) || (c.ty1_>ty2_+tol) ||
162 (c.tz2_<tz1_-tol) || (c.tz1_>tz2_+tol)) return false;
163 return true;
164 }
165
166 // Setters
167 T &rx1() { return tx1_; }
168 T &rx2() { return tx2_; }
169 T &ry1() { return ty1_; }
170 T &ry2() { return ty2_; }
171 T &rz1() { return tz1_; }
172 T &rz2() { return tz2_; }
174 T &rdof1(uint32 u) {
175 assert(u<3);
176 switch (u) {
177 case 1: return ty1_;
178 case 2: return tz1_;
179 }
180 return tx1_;
181 }
183 T &rdof2(uint32 u) {
184 assert(u<3);
185 switch (u) {
186 case 1: return ty2_;
187 case 2: return tz2_;
188 }
189 return tx2_;
190 }
191 // Setting width, height, depth assumes LL corner (c111) stays constant.
193 void width(const T &t) { tx2_ = tx1_ + t; }
195 void height(const T &t) { ty2_ = ty1_ + t; }
197 void depth(const T &t) { tz2_ = tz1_ + t; }
199 void c111(const Vector3<T> &v) { tx1_ = v.x(); ty1_ = v.y(); tz1_ = v.z(); }
201 void c121(const Vector3<T> &v) { tx1_ = v.x(); ty2_ = v.y(); tz1_ = v.z(); }
203 void c211(const Vector3<T> &v) { tx2_ = v.x(); ty1_ = v.y(); tz1_ = v.z(); }
205 void c221(const Vector3<T> &v) { tx2_ = v.x(); ty2_ = v.y(); tz1_ = v.z(); }
207 void c112(const Vector3<T> &v) { tx1_ = v.x(); ty1_ = v.y(); tz2_ = v.z(); }
209 void c122(const Vector3<T> &v) { tx1_ = v.x(); ty2_ = v.y(); tz2_ = v.z(); }
211 void c212(const Vector3<T> &v) { tx2_ = v.x(); ty1_ = v.y(); tz2_ = v.z(); }
213 void c222(const Vector3<T> &v) { tx2_ = v.x(); ty2_ = v.y(); tz2_ = v.z(); }
215 void lowerBound(const Vector3<T> &v) { c111(v); }
217 void upperBound(const Vector3<T> &v) { c222(v); }
219 void size(const Vector3<T> &v) { width(v.x()); height(v.y()); depth(v.z()); }
222 Vector3<T> bound(const Vector3<T> &v) const { return Vector3<T>(pBound(tx1_,v.x(),tx2_),pBound(ty1_,v.y(),ty2_),pBound(tz1_,v.z(),tz2_)); }
223
224 // Manipulators - unary in place
226 const Extent3<T> &operator+=(const Vector3<T> &v) { tx1_+=v.x(); tx2_+=v.x(); ty1_+=v.y(); ty2_+=v.y(); tz1_+=v.z(); tz2_+=v.z(); return *this;}
228 const Extent3<T> &operator-=(const Vector3<T> &v) { tx1_-=v.x(); tx2_-=v.x(); ty1_-=v.y(); ty2_-=v.y(); tz1_-=v.z(); tz2_-=v.z(); return *this;}
229
230 // binary operators
232 Extent3<T> operator+(const Vector3<T> &v) const { Extent3<T> out(tx1_+v.x(),tx2_+v.x(),ty1_+v.y(),ty2_+v.y(),tz1_+v.z(),tz2_+v.z()); return out; }
234 Extent3<T> operator-(const Vector3<T> &v) const { Extent3<T> out(tx1_-v.x(),tx2_-v.x(),ty1_-v.y(),ty2_-v.y(),tz1_-v.z(),tz2_-v.z()); return out; }
237 Extent3<T> out(std::max<T>(tx1_,r.tx1_),std::min<T>(tx2_,r.tx2_),
238 std::max<T>(ty1_,r.ty1_),std::min<T>(ty2_,r.ty2_),
239 std::max<T>(tz1_,r.tz1_),std::min<T>(tz2_,r.tz2_));
240 return out;
241 }
244 tx1_ = std::min<T>(tx1_,r.tx1_);
245 ty1_ = std::min<T>(ty1_,r.ty1_);
246 tz1_ = std::min<T>(tz1_,r.tz1_);
247 tx2_ = std::max<T>(tx2_,r.tx2_);
248 ty2_ = std::max<T>(ty2_,r.ty2_);
249 tz2_ = std::max<T>(tz2_,r.tz2_);
250 return *this;
251 }
254 tx1_ = std::min<T>(tx1_,v.x());
255 ty1_ = std::min<T>(ty1_,v.y());
256 tz1_ = std::min<T>(tz1_,v.z());
257 tx2_ = std::max<T>(tx2_,v.x());
258 ty2_ = std::max<T>(ty2_,v.y());
259 tz2_ = std::max<T>(tz2_,v.z());
260 return *this;
261 }
263 const Extent3<T> &expandToInclude(const T &x,const T &y,const T &z) {
264 return expandToInclude(Vector3<T>(x,y,z));
265 }
268 Extent3<T> out(*this);
269 out.expandToInclude(r);
270 return out;
271 }
274 Extent3<T> out(*this);
275 out.expandToInclude(v);
276 return out;
277 }
279 Extent3<T> expandedToInclude(const T &x,const T &y,const T &z) const {
280 return expandedToInclude(Vector3<T>(x,y,z));
281 }
285 const Extent3<T> &expand(const T &tol) { tx1_ -= tol; tx2_ += tol; ty1_ -= tol; ty2_ += tol; tz1_ -= tol; tz2_ += tol; return *this; }
289 Extent3<T> expanded(const T &tol) const { Extent3<T> out(*this); return out.expand(tol); }
292 Extent3<T> biggerBy(const T &fact) const {
293 auto s = size()*0.5;
294 s += s*fact;
295 auto c = centroid();
296 Extent3<T> out(c-s,c+s);
297 return out;
298 }
300 const Extent3<T> &center(const Vector3<T> &v) {
301 Vector3<T> trans = v - this->centroid();
302 tx1_ += trans.x();
303 tx2_ += trans.x();
304 ty1_ += trans.y();
305 ty2_ += trans.y();
306 tz1_ += trans.z();
307 tz2_ += trans.z();
308 return *this;
309 }
311 Extent3<T> center(const Vector3<T> &v) const {
312 Extent3<T> out(*this);
313 out.center(v);
314 return out;
315 }
316
317private:
318 T pBound(const T &min,const T &v,const T &max) const { return std::min(std::max(v,min),max); }
319 T tx1_=T{};
320 T tx2_=T{};
321 T ty1_=T{};
322 T ty2_=T{};
323 T tz1_=T{};
324 T tz2_=T{};
325};
326
327
328// Predefined types for standard template arguments.
329using DExtent3 = Extent3<double>;
330using FExtent3 = Extent3<float>;
331using IExtent3 = Extent3<int32>;
332using UExtent3 = Extent3<uint32>;
333using I64Extent3 = Extent3<int64>;
334using U64Extent3 = Extent3<uint64>;
335
337template <class T> inline const Extent3<T> &toExtent3(const Extent3<T> &t) { return t; }
339template <class T> inline Extent3<T> toExtent3(const Extent2<T> &t) { return Extent3<T>(t.x1(),t.x2(),t.y1(),t.y2(),0.0,0.0); }
340
342// EoF
2D cartesian region in space.
Definition extent2.h:12
const T & y1() const
Returns the lower y-bound.
Definition extent2.h:34
const T & y2() const
Returns the upper y-bound.
Definition extent2.h:36
const T & x2() const
Returns the upper x-bound.
Definition extent2.h:32
const T & x1() const
Returns the lower x-bound.
Definition extent2.h:30
A Class representing a cartesian extent in 3D.
Definition extent3.h:16
const T & dof1(uint32 u) const
Returns the lower bound of degree-of-freedom dof.
Definition extent3.h:51
Extent3< T > center(const Vector3< T > &v) const
Returns a Extent2 centered about point v.
Definition extent3.h:311
T & rdof2(uint32 u)
Reference access to lower bound of degree-of-freedom dof.
Definition extent3.h:183
T volume() const
Returns the volume of the extent ( width() * height() * depth() ).
Definition extent3.h:77
Vector3< T > centroid() const
Returns the geometric center of the extent as a Vector3.
Definition extent3.h:75
void c212(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:211
Vector3< T > c211() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:98
const T & z1() const
Returns the lower bound of the extent in the y-direction.
Definition extent3.h:47
Extent3< T > operator+(const Vector3< T > &v) const
Returns the extent created ty translating this one v units.
Definition extent3.h:232
Extent3< T > expandedToInclude(const Extent3< T > &r) const
Returns an extent large enough to contain this one and r.
Definition extent3.h:267
bool intersects(const Extent3< T > &c) const
Returns true if the Extent3 C intersects (inclusive) this extent in any way.
Definition extent3.h:152
bool operator==(const Extent3< T > &c) const
Comparison operator.
Definition extent3.h:122
Vector3< T > c222() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:108
T diagonal() const
Returns the diagonal length of the extent, or the distance from the lower bound corner to the upper b...
Definition extent3.h:79
void height(const T &t)
Sets the height of the extent by moving the maximum y extent, keeping the minimum constant.
Definition extent3.h:195
Vector3< T > c121() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:96
void c211(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:203
constexpr Extent3()=default
Default constructor, no data initialization.
void c111(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:199
Extent3(const Vector3< T > &v111, const Vector3< T > &v222)
Explicit constructor, by providing the lower-bound and upper-bound as two Vector3.
Definition extent3.h:28
T height() const
Returns the size of the extent in the y-direction.
Definition extent3.h:71
T depth() const
Returns the size of the extent in the z-direction.
Definition extent3.h:73
const Extent3< T > & expandToInclude(const Vector3< T > &v)
Enlarges the extent to contain v.
Definition extent3.h:253
bool tolIsIn(const Extent3< T > &c, const T &tol) const
Returns true if the Extent3 c falls completely inside (inclusive) the extent with an added tolerance ...
Definition extent3.h:147
bool tolIntersects(const Extent3< T > &c, const T &tol) const
Returns true if the Extent3 C intersects (inclusive) this extent in any way with an added tolerance f...
Definition extent3.h:159
bool operator<(const Extent3< T > &c) const
Comparison operator, based on volume.
Definition extent3.h:128
const T & x1() const
Returns the lower bound of the extent in the x-direction.
Definition extent3.h:39
Extent3< T > expandedToInclude(const T &x, const T &y, const T &z) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition extent3.h:279
bool isIn(const Vector3< T > &v) const
Returns true if Vector3 v is "inside" the extent, inclusive.
Definition extent3.h:132
void lowerBound(const Vector3< T > &v)
Sets the lower bound of the exetnt, keeping the upper bound constant. Synonym to c111().
Definition extent3.h:215
Vector3< T > upperBound() const
Returns the upper bounding corner of the extent, maximum value of x,y, and z.
Definition extent3.h:112
const Extent3< T > & center(const Vector3< T > &v)
Centers this Extent2 about point v.
Definition extent3.h:300
Vector3< T > c112() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:102
const T & y2() const
Returns the upper bound of the extent in the y-direction.
Definition extent3.h:45
T & rz1()
Reference access to the minimum z extent.
Definition extent3.h:171
const T & dof2(uint32 u) const
Returns the upper bound of degree-of-freedom dof.
Definition extent3.h:60
T & ry1()
Reference access to the minimum y extent.
Definition extent3.h:169
bool isIn(const Extent3< T > &c) const
Returns true if the Extent3 c falls completely inside (inclusive) the extent.
Definition extent3.h:137
Vector3< T > size() const
Returns the size of the extent as a Vector3(width(),height(),depth()).
Definition extent3.h:114
bool operator>(const Extent3< T > &c) const
Comparison operator, based on volume.
Definition extent3.h:130
void c221(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:205
Extent3< T > operator-(const Vector3< T > &v) const
Returns the extent created ty translating this one -v units.
Definition extent3.h:234
void c112(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:207
T & ry2()
Reference access to the maximum y extent.
Definition extent3.h:170
const Extent3< T > & operator+=(const Vector3< T > &v)
Adds v to all extent boundaries, effectively translating it.
Definition extent3.h:226
T & rdof1(uint32 u)
Reference access to lower bound of degree-of-freedom dof.
Definition extent3.h:174
const Extent3< T > & operator-=(const Vector3< T > &v)
Subtracts v from all extent boundaries, effectively translating it.
Definition extent3.h:228
Vector3< T > corner(uint32 x, uint32 y, uint32 z) const
Definition extent3.h:82
void width(const T &t)
Sets the width of the extent by moving the maximum x extent, keeping the minimum constant.
Definition extent3.h:193
T & rx2()
Reference access to the maximum x extent.
Definition extent3.h:168
Vector3< T > c212() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:106
Extent3< T > intersectedWith(const Extent3< T > &r) const
Returns the extent formed by the intersections of the two extents. May end up empty.
Definition extent3.h:236
Vector3< T > c122() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:104
void c122(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:209
T width() const
Returns the size of the extent in the x-direction.
Definition extent3.h:69
Extent3(const Extent2< T > &r)
Definition extent3.h:32
T & rz2()
Definition extent3.h:172
Extent3(const T &x1, const T &x2, const T &y1, const T &y2, const T &z1, const T &z2)
Explicit constructor, by providing all six cartesian extents.
Definition extent3.h:25
T & rx1()
Reference access to the minimum x extent.
Definition extent3.h:167
Extent3< T > expanded(const T &tol) const
Definition extent3.h:289
Extent3< T > biggerBy(const T &fact) const
Definition extent3.h:292
void depth(const T &t)
Sets the depth of the extent by moving the maximum z extent, keeping the minimum constant.
Definition extent3.h:197
void upperBound(const Vector3< T > &v)
Sets the upper bound of the exetnt, keeping the lower bound constant. Synonym to c222().
Definition extent3.h:217
bool isEmpty() const
Returns true if the region is "inside out" in any of its three coordinates.
Definition extent3.h:118
const T & z2() const
Returns the upper bound of the extent in the y-direction.
Definition extent3.h:49
void c222(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:213
Vector3< T > c111() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:94
const Extent3< T > & expandToInclude(const T &x, const T &y, const T &z)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition extent3.h:263
void c121(const Vector3< T > &v)
Sets one of the eight characteristic corners of the extent, keeping the other three extents constant.
Definition extent3.h:201
bool operator!=(const Extent3< T > &r) const
Comparison operator.
Definition extent3.h:126
Vector3< T > lowerBound() const
Returns the lower bounding corner of the extent, minimum value of x,y, and z.
Definition extent3.h:110
const Extent3< T > & expandToInclude(const Extent3< T > &r)
Enlarges the extent to include both its original extent and r.
Definition extent3.h:243
static constexpr Extent3< T > nothing()
Returns an Extent3 with maximum negative size. Useful for calculating bounds.
Definition extent3.h:34
Extent3< T > expandedToInclude(const Vector3< T > &v) const
Returns an extent large enough to contain this one and the point v.
Definition extent3.h:273
const Extent3< T > & expand(const T &tol)
Definition extent3.h:285
bool tolIsEmpty(const double &tol=limits< double >::epsilon() *100) const
Returns true if the region is "inside out" with a tolerance in any of its three coordinates.
Definition extent3.h:120
const T & y1() const
Returns the lower bound of the extent in the y-direction.
Definition extent3.h:43
const T & x2() const
Returns the upper bound of the extent in the x-direction.
Definition extent3.h:41
Vector3< T > bound(const Vector3< T > &v) const
Definition extent3.h:222
bool tolIsIn(const Vector3< T > &v, const T &tol) const
Returns true if Vector3 v is "inside" the extent, inclusive with an added tolerance factor.
Definition extent3.h:142
void size(const Vector3< T > &v)
Specifies the size of the extent by moving the upper bound, keeping the lower bound constant.
Definition extent3.h:219
Vector3< T > c221() const
Returns one of the eith corners that characterize the extent.
Definition extent3.h:100
3D vector utility class.
Definition vect.h:150
constexpr const T & y() const
The y-component of the vector.
Definition vect.h:169
constexpr const T & x() const
The x-component of the vector.
Definition vect.h:167
constexpr const T & z() const
The z-component of the vector.
Definition vect.h:171
debug checked shorthand for std::numeric_limits<T>::
Definition limit.h:25
const Extent3< T > & toExtent3(const Extent3< T > &t)
Returns a Extent3.
Definition extent3.h:337