open_viewmin.filter_tree_plot.utilities.scalar_bars
===================================================

.. py:module:: open_viewmin.filter_tree_plot.utilities.scalar_bars

.. autoapi-nested-parse::

   Utilities for customizing and auto-updating scalar bars (colorbars)



Functions
---------

.. autoapisummary::

   open_viewmin.filter_tree_plot.utilities.scalar_bars.copy_scalar_bar_properties
   open_viewmin.filter_tree_plot.utilities.scalar_bars.move_scalar_bar_to_previous_position
   open_viewmin.filter_tree_plot.utilities.scalar_bars.rename_scalar_bar_actor_to_title
   open_viewmin.filter_tree_plot.utilities.scalar_bars.standardize_scalar_bar
   open_viewmin.filter_tree_plot.utilities.scalar_bars.update_scalar_bar


Module Contents
---------------

.. py:function:: copy_scalar_bar_properties(old_scalar_bar, scalar_bar_args)

   Copy scalar bar properties to a dictionary.

   :param old_scalar_bar: Scalar bar VTK actor
   :type old_scalar_bar: vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor
   :param scalar_bar_args: Dictionary of scalar bar properties.
   :type scalar_bar_args: dict


.. py:function:: move_scalar_bar_to_previous_position(plotter, this_scalar_bar, scalar_bar_args)

   Reposition scalar bar to its pre-update position

   :param plotter:
   :type plotter: open_viewmin.FilterTreePlot
   :param this_scalar_bar: Scalar bar VTK actor
   :type this_scalar_bar: vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor
   :param scalar_bar_args: Dictionary of scalar bar properties.
   :type scalar_bar_args: dict


.. py:function:: rename_scalar_bar_actor_to_title(plotter, scalar_bar_actor)

   Rename a scalar bar actor to match its title.

   :param plotter:
   :type plotter: open_viewmin.FilterTreePlot
   :param scalar_bar_actor: Scalar bar VTK actor
   :type scalar_bar_actor: vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor


.. py:function:: standardize_scalar_bar(plotter, scalar_bar)

   Apply default settings to scalar bar.

   Includes workaround for bugs in PyVista's display of scalar bars.

   :param plotter:
   :type plotter: open_viewmin.FilterTreePlot
   :param scalar_bar: Scalar bar VTK actor
   :type scalar_bar: vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor


.. py:function:: update_scalar_bar(plotter, actor_name, this_scalar_bar)

   Update a scalar bar based on a mesh's state.

   :param plotter:
   :type plotter: open_viewmin.FilterTreePlot
   :param actor_name: Name of mesh corresponding to this scalar bar.
   :type actor_name: str
   :param this_scalar_bar: Scalar bar VTK actor.
   :type this_scalar_bar: vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor