QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsbox3d.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsbox3d.h
3 ----------
4 begin : April 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSBOX3D_H
19#define QGSBOX3D_H
20
21#include "qgis_core.h"
22#include "qgsrectangle.h"
23
24#include <QVector3D>
25
26#include "qgspoint.h"
27
28class QgsVector3D;
29
42class CORE_EXPORT QgsBox3D
43{
44 Q_GADGET
45
46 public:
47
52#ifndef SIP_RUN
53 QgsBox3D( double xmin = std::numeric_limits<double>::quiet_NaN(), double ymin = std::numeric_limits<double>::quiet_NaN(), double zmin = std::numeric_limits<double>::quiet_NaN(),
54 double xmax = std::numeric_limits<double>::quiet_NaN(), double ymax = std::numeric_limits<double>::quiet_NaN(), double zmax = std::numeric_limits<double>::quiet_NaN(),
55 bool normalize = true );
56
62 QgsBox3D( const QgsPoint &p1, const QgsPoint &p2, bool normalize = true );
63
68 QgsBox3D( const QgsRectangle &rect,
69 double zMin = std::numeric_limits<double>::quiet_NaN(), double zMax = std::numeric_limits<double>::quiet_NaN(),
70 bool normalize = true );
71#else
72 QgsBox3D( SIP_PYOBJECT x SIP_TYPEHINT( Optional[Union[QgsPoint, QgsRectangle, float]] ) = Py_None, SIP_PYOBJECT y SIP_TYPEHINT( Optional[QgsPoint, float] ) = Py_None, SIP_PYOBJECT z SIP_TYPEHINT( Optional[Union[bool, float]] ) = Py_None, SIP_PYOBJECT x2 SIP_TYPEHINT( Optional[Union[bool, float]] ) = Py_None, SIP_PYOBJECT y2 SIP_TYPEHINT( Optional[float] ) = Py_None, SIP_PYOBJECT z2 SIP_TYPEHINT( Optional[float] ) = Py_None, SIP_PYOBJECT n SIP_TYPEHINT( Optional[bool] ) = Py_None ) [( double x = 0.0, double y = 0.0, double z = 0.0, double x2 = 0.0, double y2 = 0.0, double z2 = 0.0, bool n = true )];
73 % MethodCode
74 if ( sipCanConvertToType( a0, sipType_QgsRectangle, SIP_NOT_NONE ) && a4 == Py_None && a5 == Py_None && a6 == Py_None )
75 {
76 int state;
77 sipIsErr = 0;
78
79 QgsRectangle *p = reinterpret_cast<QgsRectangle *>( sipConvertToType( a0, sipType_QgsRectangle, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
80 if ( sipIsErr )
81 {
82 sipReleaseType( p, sipType_QgsRectangle, state );
83 }
84 else
85 {
86 double z1 = a1 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a1 );
87 double z2 = a2 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a2 );
88 bool n = a3 == Py_None ? true : PyObject_IsTrue( a3 );
89
90 sipCpp = new QgsBox3D( *p, z1, z2, n );
91 }
92 }
93 else if ( sipCanConvertToType( a0, sipType_QgsPoint, SIP_NOT_NONE ) && sipCanConvertToType( a1, sipType_QgsPoint, SIP_NOT_NONE ) && a3 == Py_None && a4 == Py_None && a5 == Py_None && a6 == Py_None )
94 {
95 int state;
96 sipIsErr = 0;
97
98 QgsPoint *pt1 = reinterpret_cast<QgsPoint *>( sipConvertToType( a0, sipType_QgsPoint, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
99 if ( sipIsErr )
100 {
101 sipReleaseType( pt1, sipType_QgsPoint, state );
102 }
103 else
104 {
105 QgsPoint *pt2 = reinterpret_cast<QgsPoint *>( sipConvertToType( a1, sipType_QgsPoint, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
106 if ( sipIsErr )
107 {
108 sipReleaseType( pt2, sipType_QgsPoint, state );
109 }
110 else
111 {
112 bool n = a2 == Py_None ? true : PyObject_IsTrue( a2 );
113 sipCpp = new QgsBox3D( *pt1, *pt2, n );
114 }
115 }
116 }
117 else if (
118 ( a0 == Py_None || PyFloat_AsDouble( a0 ) != -1.0 || !PyErr_Occurred() ) &&
119 ( a1 == Py_None || PyFloat_AsDouble( a1 ) != -1.0 || !PyErr_Occurred() ) &&
120 ( a2 == Py_None || PyFloat_AsDouble( a2 ) != -1.0 || !PyErr_Occurred() ) &&
121 ( a3 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) &&
122 ( a4 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) &&
123 ( a5 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) &&
124 ( a6 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) )
125 {
126 double x1 = a0 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a0 );
127 double y1 = a1 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a1 );
128 double z1 = a2 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a2 );
129 double x2 = a3 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a3 );
130 double y2 = a4 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a4 );
131 double z2 = a5 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a5 );
132 bool n = a6 == Py_None ? true : PyObject_IsTrue( a6 );
133 sipCpp = new QgsBox3D( x1, y1, z1, x2, y2, z2, n );
134 }
135 else // Invalid ctor arguments
136 {
137 PyErr_SetString( PyExc_TypeError, QStringLiteral( "Invalid type in constructor arguments." ).toUtf8().constData() );
138 sipIsErr = 1;
139 }
140 % End
141#endif
142
148 void setXMinimum( double x ) SIP_HOLDGIL;
149
155 void setXMaximum( double x ) SIP_HOLDGIL;
156
162 double xMinimum() const SIP_HOLDGIL { return mBounds2d.xMinimum(); }
163
169 double xMaximum() const SIP_HOLDGIL { return mBounds2d.xMaximum(); }
170
176 void setYMinimum( double y ) SIP_HOLDGIL;
177
183 void setYMaximum( double y ) SIP_HOLDGIL;
184
190 double yMinimum() const SIP_HOLDGIL { return mBounds2d.yMinimum(); }
191
197 double yMaximum() const SIP_HOLDGIL { return mBounds2d.yMaximum(); }
198
204 void setZMinimum( double z ) SIP_HOLDGIL;
205
211 void setZMaximum( double z ) SIP_HOLDGIL;
212
218 double zMinimum() const SIP_HOLDGIL { return mZmin; }
219
225 double zMaximum() const SIP_HOLDGIL { return mZmax; }
226
232 void setNull() SIP_HOLDGIL;
233
237 void normalize() SIP_HOLDGIL;
238
244 double width() const SIP_HOLDGIL { return mBounds2d.width(); }
245
251 double height() const SIP_HOLDGIL { return mBounds2d.height(); }
252
258 double depth() const SIP_HOLDGIL { return mZmax - mZmin; }
259
265 QgsVector3D center() const SIP_HOLDGIL;
266
270 double volume() const SIP_HOLDGIL { return mBounds2d.area() * ( mZmax - mZmin ); }
271
275 QgsBox3D intersect( const QgsBox3D &other ) const SIP_HOLDGIL;
276
281 bool is2d() const SIP_HOLDGIL;
282
290 bool is3D() const SIP_HOLDGIL;
291
295 bool intersects( const QgsBox3D &other ) const SIP_HOLDGIL;
296
300 bool contains( const QgsBox3D &other ) const SIP_HOLDGIL;
301
308 bool contains( const QgsPoint &point ) const SIP_HOLDGIL;
309
319 bool contains( double x, double y, double z ) const SIP_HOLDGIL;
320
326 void combineWith( const QgsBox3D &box ) SIP_HOLDGIL;
327
333 void combineWith( double x, double y, double z ) SIP_HOLDGIL;
334
338 QgsRectangle toRectangle() const SIP_HOLDGIL { return mBounds2d; }
339
346 double distanceTo( const QVector3D &point ) const SIP_HOLDGIL;
347
348 bool operator==( const QgsBox3D &other ) const SIP_HOLDGIL;
349
357 void scale( double scaleFactor, const QgsPoint &center = QgsPoint() ) SIP_HOLDGIL;
358
364 void scale( double scaleFactor, double centerX, double centerY, double centerZ ) SIP_HOLDGIL;
365
375 bool isNull() const SIP_HOLDGIL;
376
385 bool isEmpty() const SIP_HOLDGIL;
386
394 QString toString( int precision = 16 ) const SIP_HOLDGIL;
395
399 QVector< QgsVector3D > corners() const SIP_HOLDGIL;
400
405 QgsBox3D operator-( const QgsVector3D &v ) const SIP_HOLDGIL;
406
411 QgsBox3D operator+( const QgsVector3D &v ) const SIP_HOLDGIL;
412
417 QgsBox3D &operator-=( const QgsVector3D &v ) SIP_HOLDGIL;
418
423 QgsBox3D &operator+=( const QgsVector3D &v ) SIP_HOLDGIL;
424
425
426#ifdef SIP_RUN
427 SIP_PYOBJECT __repr__();
428 % MethodCode
429 QString str = QStringLiteral( "<QgsBox3D(%1, %2, %3, %4, %5, %6)>" )
430 .arg( sipCpp->xMinimum() )
431 .arg( sipCpp->yMinimum() )
432 .arg( sipCpp->zMinimum() )
433 .arg( sipCpp->xMaximum() )
434 .arg( sipCpp->yMaximum() )
435 .arg( sipCpp->zMaximum() );
436 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
437 % End
438#endif
439
440 private:
441
442 QgsRectangle mBounds2d;
443 double mZmin = std::numeric_limits<double>::quiet_NaN();
444 double mZmax = std::numeric_limits<double>::quiet_NaN();
445
446};
447
448#endif // QGSBOX3D_H
A 3-dimensional box composed of x, y, z coordinates.
Definition: qgsbox3d.h:43
double yMaximum() const
Returns the maximum y value.
Definition: qgsbox3d.h:197
double depth() const
Returns the depth of the box.
Definition: qgsbox3d.h:258
double xMinimum() const
Returns the minimum x value.
Definition: qgsbox3d.h:162
double zMaximum() const
Returns the maximum z value.
Definition: qgsbox3d.h:225
double xMaximum() const
Returns the maximum x value.
Definition: qgsbox3d.h:169
double zMinimum() const
Returns the minimum z value.
Definition: qgsbox3d.h:218
double yMinimum() const
Returns the minimum y value.
Definition: qgsbox3d.h:190
double height() const
Returns the height of the box.
Definition: qgsbox3d.h:251
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Class for storage of 3D vectors similar to QVector3D, with the difference that it uses double precisi...
Definition: qgsvector3d.h:31
#define str(x)
Definition: qgis.cpp:38
#define SIP_TYPEHINT(type)
Definition: qgis_sip.h:232
#define SIP_HOLDGIL
Definition: qgis_sip.h:171
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
int precision