open_viewmin.filter_tree_plot.utilities.scalar_bars

open_viewmin.filter_tree_plot.utilities.scalar_bars#

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

Functions#

copy_scalar_bar_properties(old_scalar_bar, scalar_bar_args)

Copy scalar bar properties to a dictionary.

move_scalar_bar_to_previous_position(plotter, ...)

Reposition scalar bar to its pre-update position

rename_scalar_bar_actor_to_title(plotter, scalar_bar_actor)

Rename a scalar bar actor to match its title.

standardize_scalar_bar(plotter, scalar_bar)

Apply default settings to scalar bar.

update_scalar_bar(plotter, actor_name, this_scalar_bar)

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

Module Contents#

copy_scalar_bar_properties(old_scalar_bar, scalar_bar_args)#

Copy scalar bar properties to a dictionary.

Parameters:

  • old_scalar_bar (vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor) – Scalar bar VTK actor

  • scalar_bar_args (dict) – Dictionary of scalar bar properties.

move_scalar_bar_to_previous_position(plotter, this_scalar_bar, scalar_bar_args)#

Reposition scalar bar to its pre-update position

Parameters:

  • plotter (open_viewmin.FilterTreePlot)

  • this_scalar_bar (vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor) – Scalar bar VTK actor

  • scalar_bar_args (dict) – Dictionary of scalar bar properties.

rename_scalar_bar_actor_to_title(plotter, scalar_bar_actor)#

Rename a scalar bar actor to match its title.

Parameters:

  • plotter (open_viewmin.FilterTreePlot)

  • scalar_bar_actor (vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor) – Scalar bar VTK actor

standardize_scalar_bar(plotter, scalar_bar)#

Apply default settings to scalar bar.

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

Parameters:
update_scalar_bar(plotter, actor_name, this_scalar_bar)#

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

Parameters:

  • plotter (open_viewmin.FilterTreePlot)

  • actor_name (str) – Name of mesh corresponding to this scalar bar.

  • this_scalar_bar (vtkmodules.vtkRenderingAnnotation.vtkScalarBarActor) – Scalar bar VTK actor.

Contents