open_viewmin.filter_tree_plot_Qt.menus.visualization_options
============================================================

.. py:module:: open_viewmin.filter_tree_plot_Qt.menus.visualization_options

.. autoapi-nested-parse::

   Define actions and set up dialogs for actor visualization options accessed
   by a dropdown menu in the actor's control toolbar



Attributes
----------

.. autoapisummary::

   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.colormaps_list


Functions
---------

.. autoapisummary::

   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.active_scalars_color_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.add_visualization_options_menu
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.apolar_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.circuit_options_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.color_picker
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.glyph_settings_choice_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.line_settings_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.make_color_array_widget
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.make_line_settings_widget
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.num_centroids_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.populate_viz_options_menu
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.remove_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.rename_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.set_opacity_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.streamlines_settings_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.tensor_ellipsoids_settings_callback
   open_viewmin.filter_tree_plot_Qt.menus.visualization_options.toggle_colorbar_callback


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

.. py:function:: active_scalars_color_callback(plotter, actor_name)

   Color an actor by its most recently used scalar dataset

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot.filter_tree_plot.FilterTreePlot`
   :param actor_name:
   :type actor_name: str


.. py:function:: add_visualization_options_menu(actor_control_toolbar)

   Create dropdown menu of actor customizations

   :param actor_control_toolbar: Actor control toolbar to which menu will be added.
   :type actor_control_toolbar: open_viewmin.filter_tree_plot_Qt.widgets_Qt.controls.ActorControlToolbar

   :rtype: qtpy.QtWidgets.QPushButton


.. py:function:: apolar_callback(plotter, actor_name)

   Toggle `apolar` flag for orientations.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: circuit_options_callback(plotter, actor_name)

   Launch dialog to set circuit filter settings.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: color_picker(plotter, actor_name)

   Launch system color dialog to set solid color of a mesh

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name: Name of mesh to color
   :type actor_name: str


.. py:function:: glyph_settings_choice_callback(plotter, actor_name)

   Launch dialog to set glyph filter settings.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: line_settings_callback(plotter, actor_name)

.. py:function:: make_color_array_widget(plotter, actor_name)

   Launch dialog for coloring a mesh by a scalar array.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: make_line_settings_widget(plotter, actor_name)

.. py:function:: num_centroids_callback(plotter, actor_name)

   Launch dialog to set centroids filter settings.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: populate_viz_options_menu(plotter, actor_name, viz_options_button=None)

   Update visualization options dropdown menu in an actor's control
   toolbar.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str
   :param viz_options_button:
   :type viz_options_button: qtpy.QtWidgets.QPushButton, optional


.. py:function:: remove_callback(plotter, actor_name)

   Launch dialog to remove a mesh.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: rename_callback(plotter, actor_name)

   Launch dialog to rename a mesh.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: set_opacity_callback(plotter, actor_name)

   Launch dialog for opacity and lighting settings.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: streamlines_settings_callback(plotter, actor_name)

   Launch dialog to set streamlines filter settings.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: tensor_ellipsoids_settings_callback(plotter, actor_name)

   Launch dialog to set tensor ellipsoids filter settings.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:function:: toggle_colorbar_callback(plotter, actor_name)

   Toggle visibility of mesh's colorbar, if it exists.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param actor_name:
   :type actor_name: str


.. py:data:: colormaps_list