pyvista.Capsule

Capsule(

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

direction: VectorLike[float] = (1.0, 0.0, 0.0),

radius: float = 0.5,

cylinder_length: float = 1.0,

resolution: int = 30,

) → PolyData

Create the surface of a capsule.

Warning

pyvista.Capsule() function rotates the capsule pyvista.PolyData in its own way. It rotates the output 90 degrees in z-axis, translates and orients the mesh to a new center and direction.

Note

A class:pyvista.CylinderSource is used to generate the capsule mesh. For vtk versions below 9.3, a separate pyvista.CapsuleSource class is used instead. The mesh geometries are similar but not identical.

Added in version 0.44.0.

Parameters:

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

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

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

Direction the capsule points to in [x, y, z].

radiusfloat, default: 0.5

Radius of the capsule.

cylinder_lengthfloat, default: 1.0

Cylinder length of the capsule.

resolutionint, default: 30

Number of points on the circular face of the cylinder.

Returns:

pyvista.PolyData

Capsule surface.

See also

pyvista.Cylinder

Examples

Create a capsule using default parameters.

>>> import pyvista as pv
>>> capsule = pv.Capsule()
>>> capsule.plot(show_edges=True)

Static Scene

Interactive Scene