diff options
Diffstat (limited to 'doc/source/modules/gui/plot3d')
-rw-r--r-- | doc/source/modules/gui/plot3d/actions.rst | 17 | ||||
-rw-r--r-- | doc/source/modules/gui/plot3d/dev.rst | 8 | ||||
-rw-r--r-- | doc/source/modules/gui/plot3d/index.rst | 39 | ||||
-rw-r--r-- | doc/source/modules/gui/plot3d/scalarfieldview.rst | 7 | ||||
-rw-r--r-- | doc/source/modules/gui/plot3d/toolbars.rst | 29 | ||||
-rw-r--r-- | doc/source/modules/gui/plot3d/tools.rst | 40 |
6 files changed, 57 insertions, 83 deletions
diff --git a/doc/source/modules/gui/plot3d/actions.rst b/doc/source/modules/gui/plot3d/actions.rst index a2fde68..c9e3af2 100644 --- a/doc/source/modules/gui/plot3d/actions.rst +++ b/doc/source/modules/gui/plot3d/actions.rst @@ -1,10 +1,15 @@ -Actions -======= +:mod:`actions` +============== -:mod:`Plot3DActions` --------------------- +.. currentmodule:: silx.gui.plot3d.actions -.. currentmodule:: silx.gui.plot3d.Plot3DActions +.. automodule:: silx.gui.plot3d.actions + :members: + +.. automodule:: silx.gui.plot3d.actions.io + :members: -.. automodule:: silx.gui.plot3d.Plot3DActions +.. automodule:: silx.gui.plot3d.actions.mode :members: + +.. autoclass:: Plot3DAction diff --git a/doc/source/modules/gui/plot3d/dev.rst b/doc/source/modules/gui/plot3d/dev.rst index 757240e..96704f8 100644 --- a/doc/source/modules/gui/plot3d/dev.rst +++ b/doc/source/modules/gui/plot3d/dev.rst @@ -12,10 +12,10 @@ Widget-level API Widgets are available as modules of the :mod:`silx.gui.plot3d` packages. The :mod:`.Plot3DWidget` module provides the OpenGL canvas where the scene is rendered. -The :mod:`.Plot3DWindow` module provides a :class:`QMainWindow` with a :class:`Plot3DWindow` as its central widget -and toolbars: :class:`ViewpointToolBar` and :class:`Plot3DToolBar`. -:class:`QAction` that can be associated with a :class:`Plot3DWidget` are defined in the :mod:`.Plot3DActions` module. -Those actions are used by the :class:`Plot3DToolBar` toolbar. +The :mod:`.Plot3DWindow` module provides a :class:`QMainWindow` with a :class:`Plot3DWindow` as its central widget, +toolbars (:class:`InteractiveModeToolBar` and :class:`OutputToolBar`) and a :class:`ViewpointToolButton` in a toolbar. +:class:`QAction` that can be associated with a :class:`Plot3DWidget` are defined in the :mod:`.actions` module. +Those actions are used by the :class:`OutputToolBar` and the :class:`InteractiveModeToolBar` toolbars. The :mod:`.ScalarFieldView` module defines the :class:`ScalarFieldView` widget that displays iso-surfaces of a 3D scalar data set and the associated classes. The :mod:`.SFViewParamTree` module defines a :class:`SFViewParamTree.TreeView` widget that can be attached to a :class:`ScalarFieldView` to control the display. diff --git a/doc/source/modules/gui/plot3d/index.rst b/doc/source/modules/gui/plot3d/index.rst index 8941403..38b8f02 100644 --- a/doc/source/modules/gui/plot3d/index.rst +++ b/doc/source/modules/gui/plot3d/index.rst @@ -11,42 +11,7 @@ Widgets gallery --------------- -.. |imgPlot3DWidget| image:: img/Plot3DWidget.png - :height: 150px - :align: middle - -.. |imgPlot3DWindow| image:: img/Plot3DWindow.png - :height: 150px - :align: middle - -.. |imgScalarFieldView| image:: img/ScalarFieldView.png - :height: 150px - :align: middle - -.. |imgSFViewParamTree| image:: img/SFViewParamTree.png - :height: 150px - :align: middle - -.. list-table:: - :widths: 1 4 - :header-rows: 1 - - * - Widget - - Description - * - |imgScalarFieldView| - - :class:`ScalarFieldView` is a :class:`Plot3DWindow` dedicated to display 3D scalar field. - It can display iso-surfaces and an interactive cutting plane. - Sample code: :doc:`viewer3dvolume_example`. - * - |imgPlot3DWindow| - - :class:`Plot3DWindow` is a :class:`QMainWindow` with a :class:`Plot3DWidget` as central widget - and toolbars. - * - |imgPlot3DWidget| - - :class:`Plot3DWidget` is the base Qt widget providing an OpenGL 3D scene. - Other widgets are using this widget as the OpenGL scene canvas. - * - |imgSFViewParamTree| - - :class:`SFViewParamTree` is a :class:`QTreeView` widget that can be attached to a :class:`ScalarFieldView`. - It displays current parameters of the :class:`ScalarFieldView` and allows to modify it. - Sample code: :doc:`viewer3dvolume_example`. +See :ref:`plot3d-gallery` gallery. Public modules -------------- @@ -60,7 +25,7 @@ The following sub-modules are available: plot3dwindow.rst scalarfieldview.rst sfviewparamtree.rst - toolbars.rst + tools.rst actions.rst diff --git a/doc/source/modules/gui/plot3d/scalarfieldview.rst b/doc/source/modules/gui/plot3d/scalarfieldview.rst index 763c18e..80127ea 100644 --- a/doc/source/modules/gui/plot3d/scalarfieldview.rst +++ b/doc/source/modules/gui/plot3d/scalarfieldview.rst @@ -21,13 +21,6 @@ Helper classes Those classes are used by :class:`ScalarFieldView`. -:class:`Colormap` -+++++++++++++++++ - -.. autoclass:: Colormap - :show-inheritance: - :members: - :class:`CutPlane` +++++++++++++++++ diff --git a/doc/source/modules/gui/plot3d/toolbars.rst b/doc/source/modules/gui/plot3d/toolbars.rst deleted file mode 100644 index df4b4ef..0000000 --- a/doc/source/modules/gui/plot3d/toolbars.rst +++ /dev/null @@ -1,29 +0,0 @@ -Toolbars -======== - - -:mod:`ViewpointToolbar` ------------------------ - -.. currentmodule:: silx.gui.plot3d.ViewpointToolBar - -.. automodule:: silx.gui.plot3d.ViewpointToolBar - -.. autoclass:: ViewpointActionGroup - :show-inheritance: - :members: - -.. autoclass:: ViewpointToolBar - :show-inheritance: - :members: - -:mod:`Plot3DToolbar` --------------------- - -.. currentmodule:: silx.gui.plot3d.Plot3DToolBar - -.. automodule:: silx.gui.plot3d.Plot3DToolBar - -.. autoclass:: Plot3DToolBar - :show-inheritance: - :members: diff --git a/doc/source/modules/gui/plot3d/tools.rst b/doc/source/modules/gui/plot3d/tools.rst new file mode 100644 index 0000000..6cd433b --- /dev/null +++ b/doc/source/modules/gui/plot3d/tools.rst @@ -0,0 +1,40 @@ +:mod:`tools` +============ + +.. currentmodule:: silx.gui.plot3d.tools + +.. automodule:: silx.gui.plot3d.tools + +Toolbars +-------- + +:class:`InteractiveModeToolbar` ++++++++++++++++++++++++++++++++ + +.. autoclass:: InteractiveModeToolBar + :show-inheritance: + :members: + +:class:`OutputToolBar` +++++++++++++++++++++++ + +.. autoclass:: OutputToolBar + :show-inheritance: + :members: + +:class:`ViewpointToolbar` ++++++++++++++++++++++++++ + +.. autoclass:: ViewpointToolBar + :show-inheritance: + :members: + +Tool Buttons +------------ + +:class:`ViewpointToolButton` +++++++++++++++++++++++++++++ + +.. autoclass:: ViewpointToolButton + :show-inheritance: + :members: |