CubeSource

class CubeSource(*args, **kwargs)

Cube source algorithm class.

Added in version 0.44.0.

Parameters:

centersequence[float], default: (0.0, 0.0, 0.0)

Center in [x, y, z].

x_lengthfloat, default: 1.0

Length of the cube in the x-direction.

y_lengthfloat, default: 1.0

Length of the cube in the y-direction.

z_lengthfloat, default: 1.0

Length of the cube in the z-direction.

boundssequence[float], optional

Specify the bounding box of the cube. If given, all other size arguments are ignored. (x_min, x_max, y_min, y_max, z_min, z_max).

points_dtypestr, optional

Set the desired output point types. It must be either ‘float32’ or ‘float64’. Ignored unless pyvista.core.config.Config.points_dtype is None, its default, or 'preserve'.

Added in version 0.49.

point_dtypestr, optional

Set the desired output point types.

Added in version 0.44.0.

Deprecated since version 0.49: Renamed to points_dtype, matching pyvista.core.config.Config.points_dtype.

Examples

Download Python source code | Download Jupyter notebook

Create a default CubeSource.

>>> import pyvista as pv
>>> source = pv.CubeSource()
>>> source.output.plot(show_edges=True, line_width=5)

Static Scene

Interactive Scene

Used In

Docstring Examples

• CubeFacesSource (1 use)

Inheritance

Wraps vtkCubeSource.

Attributes

CubeSource.bounds	Return or set the bounding box of the cube.
CubeSource.center	Get the center in [x, y, z].
CubeSource.output	Get the output data object for a port on this algorithm.
CubeSource.point_dtype	Return or set the dtype of the points this source generates.
CubeSource.points_dtype	Return or set the dtype of the points this source generates.
CubeSource.x_length	Get the x length along the cube in its specified direction.
CubeSource.y_length	Get the y length along the cube in its specified direction.
CubeSource.z_length	Get the z length along the cube in its specified direction.