pyvista.PlaneSource

class PlaneSource(

i_resolution: int = 10,

j_resolution: int = 10,

center: VectorLike[float] = (0.0, 0.0, 0.0),

origin: VectorLike[float] = (-0.5, -0.5, 0.0),

point_a: VectorLike[float] = (0.5, -0.5, 0.0),

point_b: VectorLike[float] = (-0.5, 0.5, 0.0),

)

Create a plane source.

The plane is defined by specifying an origin point, and then two other points that, together with the origin, define two axes for the plane (magnitude and direction). These axes do not have to be orthogonal - so you can create a parallelogram. The axes must not be parallel.

Added in version 0.44.

Parameters:

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.

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

Center in [x, y, z].

originsequence[float], default: (-0.5, -0.5, 0.0)

Origin in [x, y, z].

point_asequence[float], default: (0.5, -0.5, 0.0)

Location in [x, y, z].

point_bsequence[float], default: (-0.5, 0.5, 0.0)

Location in [x, y, z].

Methods

PlaneSource.flip_normal()	Flip the plane's normal.
PlaneSource.push(distance)	Translate the plane in the direction of the normal by the distance specified.

Attributes

PlaneSource.center	Get the center in [x, y, z].
PlaneSource.i_resolution	Number of points on the plane in the i direction.
PlaneSource.j_resolution	Number of points on the plane in the j direction.
PlaneSource.normal	Get the plane's normal vector.
PlaneSource.origin	Get the origin in [x, y, z].
PlaneSource.output	Get the output data object for a port on this algorithm.
PlaneSource.point_a	Get the Location in [x, y, z].
PlaneSource.point_b	Get the Location in [x, y, z].