Box

Box#

Box(
bounds: VectorLike[float] = (-1.0, 1.0, -1.0, 1.0, -1.0, 1.0),
level: int | VectorLike[int] = 0,
quads: bool = True,
) → PolyData[source]#

Create a box with solid faces for the given bounds.

Parameters:
boundssequence[float], default: (-1.0, 1.0, -1.0, 1.0, -1.0, 1.0)

Specify the bounding box of the cube. (x_min, x_max, y_min, y_max, z_min, z_max).

levelint | VectorLike[int], default: 0

Level of subdivision of the faces.

Note

The algorithm is not optimized when a 3 length vector is given.

Added in version 0.47: Enable specifying different values for x, y, and z directions.

quadsbool, default: True

Flag to tell the source to generate either a quad or two triangle for a set of four points.

Returns:
pyvista.PolyData

Mesh of the box.

Examples#

Download Python source code | Download Jupyter notebook

Create a box with subdivision level=2.

>>> import pyvista as pv
>>> mesh = pv.Box(level=2)
>>> mesh.plot(show_edges=True)
../../../_images/pyvista-Box-82e55645b35db7ee_00_00.png

Set the level separately for each axis.

>>> mesh = pv.Box(level=[1, 2, 3])
>>> mesh.plot(show_edges=True)
../../../_images/pyvista-Box-82e55645b35db7ee_01_00.png
Contents
Backed by CoDimensional PBC