open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets
================================================================

.. py:module:: open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets

.. autoapi-nested-parse::

   Routines to create and modify the in-GUI text representation of the
   filters tree



Functions
---------

.. autoapisummary::

   open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets.add_filters_tree_top_item
   open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets.create_filters_tree
   open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets.fill_filters_tree_recursively
   open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets.format_for_filters_tree
   open_viewmin.filter_tree_plot_Qt.widgets_Qt.filters_tree_widgets.update_filters_tree


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

.. py:function:: add_filters_tree_top_item(plotter, mesh_name, is_mesh=True, is_actor=False)

   Add top-level (root) item to the filters tree GUI representation

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param mesh_name:
   :type mesh_name: str
   :param is_mesh:
   :type is_mesh: bool or `None`
   :param is_actor:
   :type is_actor: bool or `None`


.. py:function:: create_filters_tree(plotter)

   Set up a logical tree of parent-child pairs of meshes and actors,
   to be displayed in the controls area


.. py:function:: fill_filters_tree_recursively(plotter, parent_filter_name, parent_tree_item)

   For each branch of filters tree, find all child meshes and their child
   meshes, etc., until reaching actors (leaves of tree)

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param parent_filter_name:
   :type parent_filter_name: str
   :param parent_tree_item:
   :type parent_tree_item: qtpy.QtWidgets.QTreeWidgetItem


.. py:function:: format_for_filters_tree(plotter, label, is_mesh=None, is_actor=None)

   Create a text item for the filters tree GUI representation

   The text is formatted according to whether the filter is associated with
   a mesh and/or actor.

   :param plotter:
   :type plotter: :class:`~open_viewmin.filter_tree_plot_Qt.filter_tree_plot_Qt.FilterTreePlotQt`
   :param label:
   :type label: str
   :param is_mesh:
   :type is_mesh: bool or `None`
   :param is_actor:
   :type is_actor: bool or None`

   :rtype: qtpy.QtWidgets.QTreeWidgetItem


.. py:function:: update_filters_tree(plotter)

   Update the GUI representation of the filters tree

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