cratermaker.utils.general_utils.update_pyvista_help_message

cratermaker.utils.general_utils.update_pyvista_help_message(plotter, new_message=None)

Add a help message to a PyVista plotter with instructions for user interactions.

Parameters:

• plotter (pyvista.Plotter) – The PyVista plotter to which the help message will be added.

• new_message (str, optional) – An additional message to prepend to the default help instructions. If None, only the default instructions will be shown.

Returns:

pyvista.Plotter – The updated PyVista plotter with the help message added and key event for toggling the message set up.