plot_wave

plot_wave(fps=30, frequency=1, wavetime=3, interactive=False, notebook=None)

Plot a 3D moving wave in a render window.

Parameters
fpsint, optional

Maximum frames per second to display. Defaults to 30.

frequencyfloat, optional

Wave cycles per second. Defaults to 1 Hz.

wavetimefloat, optional

The desired total display time in seconds. Defaults to 3 seconds.

interactivebool, optional

Allows the user to set the camera position before the start of the wave movement. Default False.

notebookbool, optional

When True, the resulting plot is placed inline a jupyter notebook. Assumes a jupyter console is active.

Returns
numpy.ndarray

Position of points at last frame.

Examples

>>> from pyvista import demos
>>> out = demos.plot_wave()
../../../_images/pyvista-demos-demos-plot_wave-1_00_00.png