pyvista.Arrow#

Arrow(start=(0.0, 0.0, 0.0), direction=(1.0, 0.0, 0.0), tip_length=0.25, tip_radius=0.1, tip_resolution=20, shaft_radius=0.05, shaft_resolution=20, scale=None)[source]#

Create an arrow.

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

Start location in [x, y, z].

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

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

tip_lengthfloat, default: 0.25

Length of the tip.

tip_radiusfloat, default: 0.1

Radius of the tip.

tip_resolutionint, default: 20

Number of faces around the tip.

shaft_radiusfloat, default: 0.05

Radius of the shaft.

shaft_resolutionint, default: 20

Number of faces around the shaft.

scalefloat | str, optional

Scale factor of the entire object, defaults to a scale of 1. 'auto' scales to length of direction array.

Returns:
pyvista.PolyData

Arrow mesh.

Examples

Plot a default arrow.

>>> import pyvista as pv
>>> mesh = pv.Arrow()
>>> mesh.plot(show_edges=True)
https://d33wubrfki0l68.cloudfront.net/3e1baad97065b95a0ab41720411fe5c549470cc3/ab27c/_images/pyvista-arrow-1_00_00.png