generate_orbital_path

Plotter.generate_orbital_path(factor=3.0, n_points=20, viewup=None, shift=0.0)

Generate an orbital path around the data scene.

Parameters
factorfloat, optional

A scaling factor when building the orbital extent.

n_pointsint, optional

Number of points on the orbital path.

viewuplist(float), optional

The normal to the orbital plane.

shiftfloat, optional

Shift the plane up/down from the center of the scene by this amount.

Returns
pyvista.PolyData

PolyData containing the orbital path.

Examples

Generate an orbital path around a sphere.

>>> import pyvista
>>> plotter = pyvista.Plotter()
>>> _ = plotter.add_mesh(pyvista.Sphere())
>>> viewup = [0, 0, 1]
>>> orbit = plotter.generate_orbital_path(factor=2.0, n_points=50,
...                                       shift=0.0, viewup=viewup)

See Orbiting for a full example using this method.

../../../_images/pyvista-Plotter-generate_orbital_path-1_00_00.png