pyvista.Plane

Contents

pyvista.Plane#

Plane(
center: VectorLike[float] = (0.0, 0.0, 0.0),
direction: VectorLike[float] = (0.0, 0.0, 1.0),
i_size: int = 1,
j_size: int = 1,
i_resolution: int = 10,
j_resolution: int = 10,
) → PolyData[source]#

Create a plane.

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

Location of the centroid in [x, y, z].

directionsequence[float], default: (0.0, 0.0, 1.0)

Direction of the plane’s normal in [x, y, z].

i_sizefloat, default: 1.0

Size of the plane in the i direction.

j_sizefloat, default: 1.0

Size of the plane in the j direction.

i_resolutionint, default: 10

Number of points on the plane in the i direction.

j_resolutionint, default: 10

Number of points on the plane in the j direction.

Returns:
pyvista.PolyData

Plane mesh.

Examples

Create a default plane.

>>> import pyvista as pv
>>> mesh = pv.Plane()
>>> mesh.point_data.clear()
>>> mesh.plot(show_edges=True)
../../../_images/pyvista-Plane-1_00_00.png
Contents