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, default: 30

Maximum frames per second to display.

frequencyfloat, default: 1.0

Wave cycles per second (Hz).

wavetimefloat, default: 3.0

The desired total display time in seconds.

interactivebool, default: False

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

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()