Class: QgsBox3d¶
- class qgis.core.QgsBox3d¶
Bases:
sip.wrapper
A 3-dimensional box composed of x, y, z coordinates.
A box composed of x/y/z minimum and maximum values. It is often used to return the 3D extent of a geometry or collection of geometries.
See also
New in version 3.0.
QgsBox3d(xmin: float = 0, ymin: float = 0, zmin: float = 0, xmax: float = 0, ymax: float = 0, zmax: float = 0) Constructor for
QgsBox3D
which accepts the ranges of x/y/z coordinates.QgsBox3d(p1:
QgsPoint
, p2:QgsPoint
) Constructs aQgsBox3D
from two points representing opposite corners of the box. The box is normalized after construction.QgsBox3d(rect:
QgsRectangle
) Constructs aQgsBox3D
from a rectangle. Z Minimum and Z Maximum are set to 0.0.QgsBox3d(
QgsBox3d
)Methods
Returns
True
when box contains other box.Returns the depth of the box.
Returns the smallest distance between the box and the point
point
(returns 0 if the point is inside the box)Returns the height of the box.
Returns the intersection of this box and another 3D box.
Returns
True
if box intersects with another box.Returns
True
if the box can be considered a 2-dimensional box, i.e. it has equal minimum and maximum z values.Normalize the box so it has non-negative width/height/depth.
Scale the rectangle around a
center
QgsPoint
.Sets the maximum
x
value.Sets the minimum
x
value.Sets the maximum
y
value.Sets the minimum
y
value.Sets the maximum
z
value.Sets the minimum
z
value.Converts the box to a 2D rectangle.
Returns the volume of the box.
Returns the width of the box.
Returns the maximum x value.
Returns the minimum x value.
Returns the maximum y value.
Returns the minimum y value.
Returns the maximum z value.
Returns the minimum z value.
- contains(self, other: QgsBox3d) bool ¶
Returns
True
when box contains other box.contains(self, point:
QgsPoint
) -> bool ReturnsTrue
when box contains apoint
.If the point is a 2D point (no z-coordinate), then the containment test will be performed on the x/y extent of the box only.
- Parameters
other (QgsBox3d) –
- Return type
bool
- depth(self) float ¶
Returns the depth of the box.
See also
See also
- Return type
float
- distanceTo(self, point: QVector3D) float ¶
Returns the smallest distance between the box and the point
point
(returns 0 if the point is inside the box)New in version 3.18.
- Parameters
point (QVector3D) –
- Return type
float
- height(self) float ¶
Returns the height of the box.
See also
See also
- Return type
float
- intersect(self, other: QgsBox3d) QgsBox3d ¶
Returns the intersection of this box and another 3D box.
- intersects(self, other: QgsBox3d) bool ¶
Returns
True
if box intersects with another box.- Parameters
other (QgsBox3d) –
- Return type
bool
- is2d(self) bool ¶
Returns
True
if the box can be considered a 2-dimensional box, i.e. it has equal minimum and maximum z values.- Return type
bool
- normalize(self)¶
Normalize the box so it has non-negative width/height/depth.
- scale(self, scaleFactor: float, center: QgsPoint = QgsPoint())¶
Scale the rectangle around a
center
QgsPoint
.If no
center
point is specified then the current center of the box will be used.New in version 3.26.
scale(self, scaleFactor: float, centerX: float, centerY: float, centerZ: float) Scale the rectangle around a center coordinates.
New in version 3.26.
- Parameters
scaleFactor (float) –
center (
QgsPoint
= QgsPoint()) –
- setXMaximum(self, x: float)¶
Sets the maximum
x
value.See also
See also
- Parameters
x (float) –
- setXMinimum(self, x: float)¶
Sets the minimum
x
value.See also
See also
- Parameters
x (float) –
- setYMaximum(self, y: float)¶
Sets the maximum
y
value.See also
See also
- Parameters
y (float) –
- setYMinimum(self, y: float)¶
Sets the minimum
y
value.See also
See also
- Parameters
y (float) –
- setZMaximum(self, z: float)¶
Sets the maximum
z
value.See also
See also
- Parameters
z (float) –
- setZMinimum(self, z: float)¶
Sets the minimum
z
value.See also
See also
- Parameters
z (float) –
- toRectangle(self) QgsRectangle ¶
Converts the box to a 2D rectangle.
- Return type
- volume(self) float ¶
Returns the volume of the box.
- Return type
float
- width(self) float ¶
Returns the width of the box.
See also
See also
- Return type
float
- xMaximum(self) float ¶
Returns the maximum x value.
See also
See also
- Return type
float
- xMinimum(self) float ¶
Returns the minimum x value.
See also
See also
- Return type
float
- yMaximum(self) float ¶
Returns the maximum y value.
See also
See also
- Return type
float
- yMinimum(self) float ¶
Returns the minimum y value.
See also
See also
- Return type
float
- zMaximum(self) float ¶
Returns the maximum z value.
See also
See also
- Return type
float
- zMinimum(self) float ¶
Returns the minimum z value.
See also
See also
- Return type
float