QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
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 "qgspoint.h"
23#include "qgsrectangle.h"
24
25#include <QVector3D>
26
27class QgsVector3D;
28
41class CORE_EXPORT QgsBox3D
42{
43 Q_GADGET
44
45 public:
46
51#ifndef SIP_RUN
52 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(),
53 double xmax = std::numeric_limits<double>::quiet_NaN(), double ymax = std::numeric_limits<double>::quiet_NaN(), double zmax = std::numeric_limits<double>::quiet_NaN(),
54 bool normalize = true );
55
61 QgsBox3D( const QgsPoint &p1, const QgsPoint &p2, bool normalize = true );
62
69 QgsBox3D( const QgsVector3D &corner1, const QgsVector3D &corner2, bool normalize = true );
70
75 QgsBox3D( const QgsRectangle &rect,
76 double zMin = std::numeric_limits<double>::quiet_NaN(), double zMax = std::numeric_limits<double>::quiet_NaN(),
77 bool normalize = true );
78
79#else
80 QgsBox3D( SIP_PYOBJECT x SIP_TYPEHINT( Optional[Union[QgsPoint, QgsVector3D, QgsRectangle, float]] ) = Py_None, SIP_PYOBJECT y SIP_TYPEHINT( Optional[QgsPoint, QgsVector3D, 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 )];
81 % MethodCode
82 if ( sipCanConvertToType( a0, sipType_QgsRectangle, SIP_NOT_NONE ) && a4 == Py_None && a5 == Py_None && a6 == Py_None )
83 {
84 int state;
85 sipIsErr = 0;
86
87 QgsRectangle *p = reinterpret_cast<QgsRectangle *>( sipConvertToType( a0, sipType_QgsRectangle, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
88 if ( !sipIsErr )
89 {
90 double z1 = a1 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a1 );
91 double z2 = a2 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a2 );
92 bool n = a3 == Py_None ? true : PyObject_IsTrue( a3 );
93
94 sipCpp = new QgsBox3D( *p, z1, z2, n );
95 }
96 sipReleaseType( p, sipType_QgsRectangle, state );
97 }
98 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 )
99 {
100 int state;
101 sipIsErr = 0;
102
103 QgsPoint *pt1 = reinterpret_cast<QgsPoint *>( sipConvertToType( a0, sipType_QgsPoint, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
104 if ( !sipIsErr )
105 {
106 QgsPoint *pt2 = reinterpret_cast<QgsPoint *>( sipConvertToType( a1, sipType_QgsPoint, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
107 if ( !sipIsErr )
108 {
109 bool n = a2 == Py_None ? true : PyObject_IsTrue( a2 );
110 sipCpp = new QgsBox3D( *pt1, *pt2, n );
111 }
112 sipReleaseType( pt2, sipType_QgsPoint, state );
113 }
114 sipReleaseType( pt1, sipType_QgsPoint, state );
115 }
116 else if ( sipCanConvertToType( a0, sipType_QgsVector3D, SIP_NOT_NONE ) && sipCanConvertToType( a1, sipType_QgsVector3D, SIP_NOT_NONE ) && a3 == Py_None && a4 == Py_None && a5 == Py_None && a6 == Py_None )
117 {
118 int state;
119 sipIsErr = 0;
120
121 QgsVector3D *corner1 = reinterpret_cast<QgsVector3D *>( sipConvertToType( a0, sipType_QgsVector3D, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
122 if ( !sipIsErr )
123 {
124 QgsVector3D *corner2 = reinterpret_cast<QgsVector3D *>( sipConvertToType( a1, sipType_QgsVector3D, 0, SIP_NOT_NONE, &state, &sipIsErr ) );
125 if ( !sipIsErr )
126 {
127 bool n = a2 == Py_None ? true : PyObject_IsTrue( a2 );
128 sipCpp = new QgsBox3D( *corner1, *corner2, n );
129 }
130 sipReleaseType( corner2, sipType_QgsVector3D, state );
131 }
132 sipReleaseType( corner1, sipType_QgsVector3D, state );
133 }
134 else if (
135 ( a0 == Py_None || PyFloat_AsDouble( a0 ) != -1.0 || !PyErr_Occurred() ) &&
136 ( a1 == Py_None || PyFloat_AsDouble( a1 ) != -1.0 || !PyErr_Occurred() ) &&
137 ( a2 == Py_None || PyFloat_AsDouble( a2 ) != -1.0 || !PyErr_Occurred() ) &&
138 ( a3 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) &&
139 ( a4 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) &&
140 ( a5 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) &&
141 ( a6 == Py_None || PyFloat_AsDouble( a3 ) != -1.0 || !PyErr_Occurred() ) )
142 {
143 double x1 = a0 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a0 );
144 double y1 = a1 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a1 );
145 double z1 = a2 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a2 );
146 double x2 = a3 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a3 );
147 double y2 = a4 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a4 );
148 double z2 = a5 == Py_None ? std::numeric_limits<double>::quiet_NaN() : PyFloat_AsDouble( a5 );
149 bool n = a6 == Py_None ? true : PyObject_IsTrue( a6 );
150 sipCpp = new QgsBox3D( x1, y1, z1, x2, y2, z2, n );
151 }
152 else // Invalid ctor arguments
153 {
154 PyErr_SetString( PyExc_TypeError, QStringLiteral( "Invalid type in constructor arguments." ).toUtf8().constData() );
155 sipIsErr = 1;
156 }
157 % End
158#endif
159
165 void set( double xMin, double yMin, double zMin, double xMax, double yMax, double zMax, bool normalize = true )
166 {
167 mBounds2d.set( xMin, yMin, xMax, yMax, false );
168 mZmin = zMin;
169 mZmax = zMax;
170 if ( normalize )
171 {
172 QgsBox3D::normalize();
173 }
174 }
175
181 void setXMinimum( double x ) SIP_HOLDGIL;
182
188 void setXMaximum( double x ) SIP_HOLDGIL;
189
195 double xMinimum() const SIP_HOLDGIL { return mBounds2d.xMinimum(); }
196
202 double xMaximum() const SIP_HOLDGIL { return mBounds2d.xMaximum(); }
203
209 void setYMinimum( double y ) SIP_HOLDGIL;
210
216 void setYMaximum( double y ) SIP_HOLDGIL;
217
223 double yMinimum() const SIP_HOLDGIL { return mBounds2d.yMinimum(); }
224
230 double yMaximum() const SIP_HOLDGIL { return mBounds2d.yMaximum(); }
231
237 void setZMinimum( double z ) SIP_HOLDGIL;
238
244 void setZMaximum( double z ) SIP_HOLDGIL;
245
251 double zMinimum() const SIP_HOLDGIL { return mZmin; }
252
258 double zMaximum() const SIP_HOLDGIL { return mZmax; }
259
265 void setNull() SIP_HOLDGIL;
266
270 void normalize() SIP_HOLDGIL;
271
277 double width() const SIP_HOLDGIL { return mBounds2d.width(); }
278
284 double height() const SIP_HOLDGIL { return mBounds2d.height(); }
285
291 double depth() const SIP_HOLDGIL { return mZmax - mZmin; }
292
298 QgsVector3D center() const SIP_HOLDGIL;
299
305 double area() const SIP_HOLDGIL { return mBounds2d.area(); }
306
310 double volume() const SIP_HOLDGIL { return mBounds2d.area() * ( mZmax - mZmin ); }
311
315 QgsBox3D intersect( const QgsBox3D &other ) const SIP_HOLDGIL;
316
321 bool is2d() const SIP_HOLDGIL;
322
330 bool is3D() const SIP_HOLDGIL;
331
335 bool intersects( const QgsBox3D &other ) const SIP_HOLDGIL;
336
340 bool contains( const QgsBox3D &other ) const SIP_HOLDGIL;
341
348 bool contains( const QgsPoint &point ) const SIP_HOLDGIL;
349
359 bool contains( double x, double y, double z ) const SIP_HOLDGIL;
360
366 void combineWith( const QgsBox3D &box ) SIP_HOLDGIL;
367
373 void combineWith( double x, double y, double z ) SIP_HOLDGIL;
374
378 QgsRectangle toRectangle() const SIP_HOLDGIL { return mBounds2d; }
379
387 Q_DECL_DEPRECATED double distanceTo( const QVector3D &point ) const SIP_DEPRECATED { return distanceTo( QgsVector3D( point ) ); }
388
395 double distanceTo( const QgsVector3D &point ) const SIP_HOLDGIL;
396
397 bool operator==( const QgsBox3D &other ) const SIP_HOLDGIL;
398
406 void scale( double scaleFactor, const QgsPoint &center = QgsPoint() ) SIP_HOLDGIL;
407
413 void scale( double scaleFactor, double centerX, double centerY, double centerZ ) SIP_HOLDGIL;
414
419 void grow( double delta );
420
430 bool isNull() const SIP_HOLDGIL;
431
440 bool isEmpty() const SIP_HOLDGIL;
441
449 QString toString( int precision = 16 ) const SIP_HOLDGIL;
450
454 QVector< QgsVector3D > corners() const SIP_HOLDGIL;
455
460 QgsBox3D operator-( const QgsVector3D &v ) const SIP_HOLDGIL;
461
466 QgsBox3D operator+( const QgsVector3D &v ) const SIP_HOLDGIL;
467
472 QgsBox3D &operator-=( const QgsVector3D &v ) SIP_HOLDGIL;
473
478 QgsBox3D &operator+=( const QgsVector3D &v ) SIP_HOLDGIL;
479
480
481#ifdef SIP_RUN
482 SIP_PYOBJECT __repr__();
483 % MethodCode
484 QString str = QStringLiteral( "<QgsBox3D(%1, %2, %3, %4, %5, %6)>" )
485 .arg( sipCpp->xMinimum() )
486 .arg( sipCpp->yMinimum() )
487 .arg( sipCpp->zMinimum() )
488 .arg( sipCpp->xMaximum() )
489 .arg( sipCpp->yMaximum() )
490 .arg( sipCpp->zMaximum() );
491 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
492 % End
493#endif
494
495 private:
496
497 QgsRectangle mBounds2d;
498 double mZmin = std::numeric_limits<double>::quiet_NaN();
499 double mZmax = std::numeric_limits<double>::quiet_NaN();
500
501};
502
503#endif // QGSBOX3D_H
QgsBox3D
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:42
QgsBox3D::yMaximum
double yMaximum() const
Returns the maximum y value.
Definition qgsbox3d.h:230
QgsBox3D::depth
double depth() const
Returns the depth of the box.
Definition qgsbox3d.h:291
QgsBox3D::xMinimum
double xMinimum() const
Returns the minimum x value.
Definition qgsbox3d.h:195
QgsBox3D::zMaximum
double zMaximum() const
Returns the maximum z value.
Definition qgsbox3d.h:258
QgsBox3D::xMaximum
double xMaximum() const
Returns the maximum x value.
Definition qgsbox3d.h:202
QgsBox3D::volume
double volume() const
Returns the volume of the box.
Definition qgsbox3d.h:310
QgsBox3D::normalize
void normalize()
Normalize the box so it has non-negative width/height/depth.
Definition qgsbox3d.cpp:111
QgsBox3D::toRectangle
QgsRectangle toRectangle() const
Converts the box to a 2D rectangle.
Definition qgsbox3d.h:378
QgsBox3D::distanceTo
Q_DECL_DEPRECATED double distanceTo(const QVector3D &point) const
Returns the smallest distance between the box and the point point (returns 0 if the point is inside t...
Definition qgsbox3d.h:387
QgsBox3D::area
double area() const
Returns the area of the box.
Definition qgsbox3d.h:305
QgsBox3D::set
void set(double xMin, double yMin, double zMin, double xMax, double yMax, double zMax, bool normalize=true)
Sets the box from a set of (x,y,z) minimum and maximum coordinates.
Definition qgsbox3d.h:165
QgsBox3D::QgsBox3D
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(), double xmax=std::numeric_limits< double >::quiet_NaN(), double ymax=std::numeric_limits< double >::quiet_NaN(), double zmax=std::numeric_limits< double >::quiet_NaN(), bool normalize=true)
Constructor for QgsBox3D which accepts the ranges of x/y/z coordinates.
Definition qgsbox3d.cpp:26
QgsBox3D::width
double width() const
Returns the width of the box.
Definition qgsbox3d.h:277
QgsBox3D::zMinimum
double zMinimum() const
Returns the minimum z value.
Definition qgsbox3d.h:251
QgsBox3D::yMinimum
double yMinimum() const
Returns the minimum y value.
Definition qgsbox3d.h:223
QgsBox3D::height
double height() const
Returns the height of the box.
Definition qgsbox3d.h:284
QgsPoint
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
QgsRectangle
A rectangle specified with double values.
Definition qgsrectangle.h:44
QgsVector3D
A 3D vector (similar to QVector3D) with the difference that it uses double precision instead of singl...
Definition qgsvector3d.h:30
SIP_TYPEHINT
#define SIP_TYPEHINT(type)
Definition qgis_sip.h:240
SIP_DEPRECATED
#define SIP_DEPRECATED
Definition qgis_sip.h:114
SIP_HOLDGIL
#define SIP_HOLDGIL
Definition qgis_sip.h:179
operator==
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition qgsfeatureiterator.h:433
Generated on for QGIS API Documentation by doxygen 1.15.0