pyvista.Polygon

Contents

pyvista.Polygon#

Polygon(
center: VectorLike[float] = (0.0, 0.0, 0.0),
radius: float = 1.0,
normal: VectorLike[float] = (0.0, 0.0, 1.0),
n_sides: int = 6,
fill: bool = True,
) PolyData[source]#

Create a polygon.

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

Center in [x, y, z]. Central axis of the polygon passes through this point.

radiusfloat, default: 1.0

The radius of the polygon.

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

Direction vector in [x, y, z]. Orientation vector of the polygon.

n_sidesint, default: 6

Number of sides of the polygon.

fillbool, default: True

Enable or disable producing filled polygons.

Returns:
pyvista.PolyData

Mesh of the polygon.

Examples

Create an 8 sided polygon.

>>> import pyvista as pv
>>> mesh = pv.Polygon(n_sides=8)
>>> mesh.plot(show_edges=True, line_width=5)
../../../_images/pyvista-Polygon-1_00_00.png