summaryrefslogtreecommitdiff
path: root/doc/source/modules/gui/plot3d
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/gui/plot3d')
-rw-r--r--doc/source/modules/gui/plot3d/actions.rst3
-rw-r--r--doc/source/modules/gui/plot3d/dev.rst8
-rw-r--r--doc/source/modules/gui/plot3d/img/Plot3DWindow.pngbin20571 -> 21207 bytes
-rw-r--r--doc/source/modules/gui/plot3d/img/ScalarFieldView.pngbin42407 -> 55012 bytes
-rw-r--r--doc/source/modules/gui/plot3d/img/SceneWidget.pngbin0 -> 349485 bytes
-rw-r--r--doc/source/modules/gui/plot3d/img/SceneWindow.pngbin0 -> 363783 bytes
-rw-r--r--doc/source/modules/gui/plot3d/index.rst9
-rw-r--r--doc/source/modules/gui/plot3d/items.rst173
-rw-r--r--doc/source/modules/gui/plot3d/scalarfieldview.rst2
-rw-r--r--doc/source/modules/gui/plot3d/scenewidget.rst29
-rw-r--r--doc/source/modules/gui/plot3d/scenewindow.rst22
-rw-r--r--doc/source/modules/gui/plot3d/viewer3dvolume_example.rst7
12 files changed, 235 insertions, 18 deletions
diff --git a/doc/source/modules/gui/plot3d/actions.rst b/doc/source/modules/gui/plot3d/actions.rst
index c9e3af2..66086bc 100644
--- a/doc/source/modules/gui/plot3d/actions.rst
+++ b/doc/source/modules/gui/plot3d/actions.rst
@@ -12,4 +12,7 @@
.. automodule:: silx.gui.plot3d.actions.mode
:members:
+.. automodule:: silx.gui.plot3d.actions.viewpoint
+ :members:
+
.. autoclass:: Plot3DAction
diff --git a/doc/source/modules/gui/plot3d/dev.rst b/doc/source/modules/gui/plot3d/dev.rst
index 96704f8..f135767 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,
-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:`.Plot3DWindow` module provides a :class:`QMainWindow` with a :class:`Plot3DWindow` as its central widget
+and toolbars: :class:`InteractiveModeToolBar`, :class:`ViewpointToolBar` and :class:`OutputToolBar`.
+:class:`QAction` that can be associated with a :class:`Plot3DWidget` are defined in the :mod:`.actions` package.
+Toolbars and tool buttons are available in :mod:`.tools` package.
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/img/Plot3DWindow.png b/doc/source/modules/gui/plot3d/img/Plot3DWindow.png
index 0e562f5..6066d2a 100644
--- a/doc/source/modules/gui/plot3d/img/Plot3DWindow.png
+++ b/doc/source/modules/gui/plot3d/img/Plot3DWindow.png
Binary files differ
diff --git a/doc/source/modules/gui/plot3d/img/ScalarFieldView.png b/doc/source/modules/gui/plot3d/img/ScalarFieldView.png
index f40fdac..f8f61da 100644
--- a/doc/source/modules/gui/plot3d/img/ScalarFieldView.png
+++ b/doc/source/modules/gui/plot3d/img/ScalarFieldView.png
Binary files differ
diff --git a/doc/source/modules/gui/plot3d/img/SceneWidget.png b/doc/source/modules/gui/plot3d/img/SceneWidget.png
new file mode 100644
index 0000000..610c41a
--- /dev/null
+++ b/doc/source/modules/gui/plot3d/img/SceneWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/plot3d/img/SceneWindow.png b/doc/source/modules/gui/plot3d/img/SceneWindow.png
new file mode 100644
index 0000000..c3c48af
--- /dev/null
+++ b/doc/source/modules/gui/plot3d/img/SceneWindow.png
Binary files differ
diff --git a/doc/source/modules/gui/plot3d/index.rst b/doc/source/modules/gui/plot3d/index.rst
index 38b8f02..e0a14f6 100644
--- a/doc/source/modules/gui/plot3d/index.rst
+++ b/doc/source/modules/gui/plot3d/index.rst
@@ -23,6 +23,8 @@ The following sub-modules are available:
plot3dwidget.rst
plot3dwindow.rst
+ scenewidget.rst
+ scenewindow.rst
scalarfieldview.rst
sfviewparamtree.rst
tools.rst
@@ -32,7 +34,7 @@ The following sub-modules are available:
Sample code
-----------
-- :doc:`viewer3dvolume_example`: Sample code using :class:`ScalarFieldView`
+See :ref:`plot3d-sample-code`
Internals
---------
@@ -41,8 +43,3 @@ Internals
:maxdepth: 2
dev.rst
-
-.. toctree::
- :hidden:
-
- viewer3dvolume_example.rst
diff --git a/doc/source/modules/gui/plot3d/items.rst b/doc/source/modules/gui/plot3d/items.rst
new file mode 100644
index 0000000..1162cb9
--- /dev/null
+++ b/doc/source/modules/gui/plot3d/items.rst
@@ -0,0 +1,173 @@
+.. currentmodule:: silx.gui.plot3d
+
+:mod:`items`: SceneWidget items
+===============================
+
+The following classes are items that describes the content of a :class:`SceneWidget`:
+
+.. currentmodule:: silx.gui.plot3d.items
+
+- :class:`~silx.gui.plot3d.items.image.ImageData`
+- :class:`~silx.gui.plot3d.items.image.ImageRgba`
+- :class:`~silx.gui.plot3d.items.scatter.Scatter2D`
+- :class:`~silx.gui.plot3d.items.scatter.Scatter3D`
+- :class:`~silx.gui.plot3d.items.volume.ScalarField3D`
+- :class:`~silx.gui.plot3d.items.clipplane.ClipPlane`
+- :class:`~silx.gui.plot3d.items.mesh.Mesh`
+- :class:`~silx.gui.plot3d.items.core.GroupItem`
+
+2D images
+---------
+
+.. currentmodule:: silx.gui.plot3d.core
+
+.. currentmodule:: silx.gui.plot3d.items.image
+
+:class:`ImageData`
+++++++++++++++++++
+
+:class:`ImageData` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: ImageData
+ :members: getData, setData,
+ getColormap, setColormap,
+ getInterpolation, setInterpolation
+
+:class:`ImageRgba`
+++++++++++++++++++
+
+:class:`ImageRgba` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: ImageRgba
+ :members: getData, setData,
+ getInterpolation, setInterpolation
+
+2D/3D scatter data
+------------------
+
+.. currentmodule:: silx.gui.plot3d.items.scatter
+
+:class:`Scatter2D`
+++++++++++++++++++
+
+:class:`Scatter2D` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: Scatter2D
+ :members: getData, setData, getXData, getYData, getValues,
+ supportedVisualizations, isPropertyEnabled,
+ getVisualization, setVisualization,
+ isHeightMap, setHeightMap,
+ getLineWidth, setLineWidth,
+ getColormap, setColormap,
+ getSupportedSymbols, getSymbol, setSymbol
+
+:class:`Scatter3D`
+++++++++++++++++++
+
+:class:`Scatter3D` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: Scatter3D
+ :members: getData, setData, getXData, getYData, getZData, getValues,
+ getColormap, setColormap,
+ getSupportedSymbols, getSymbol, setSymbol
+
+3D volume
+---------
+
+.. currentmodule:: silx.gui.plot3d.items.volume
+
+:class:`ScalarField3D`
+++++++++++++++++++++++
+
+:class:`ScalarField3D` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: ScalarField3D
+ :members: getData, setData,
+ getCutPlanes,
+ sigIsosurfaceAdded, sigIsosurfaceRemoved,
+ addIsosurface, getIsosurfaces, removeIsosurface, clearIsosurfaces
+
+The following classes allows to configure :class:`ScalarField3D` visualization:
+
+:class:`IsoSurface`
++++++++++++++++++++
+
+:class:`IsoSurface` inherits from :class:`.Item3D` and also provides its API.
+
+.. autoclass:: Isosurface
+ :show-inheritance:
+ :members:
+
+:class:`CutPlane`
++++++++++++++++++
+
+:class:`CutPlane` inherits from :class:`.Item3D` and also provides its API.
+
+.. autoclass:: CutPlane
+ :members: getColormap, setColormap,
+ getInterpolation, setInterpolation,
+ moveToCenter, isValid,
+ getNormal, setNormal,
+ getPoint, setPoint,
+ getParameters, setParameters,
+ getDisplayValuesBelowMin, setDisplayValuesBelowMin
+
+Clipping plane
+--------------
+
+.. currentmodule:: silx.gui.plot3d.items.clipplane
+
+:class:`ClipPlane`
+++++++++++++++++++
+
+:class:`ClipPlane` inherits from :class:`.Item3D` and also provides its API.
+
+.. autoclass:: ClipPlane
+ :show-inheritance:
+ :members:
+
+3D mesh
+-------
+
+.. currentmodule:: silx.gui.plot3d.items.mesh
+
+:class:`Mesh`
++++++++++++++
+
+:class:`Mesh` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: Mesh
+ :show-inheritance:
+ :members:
+
+Item base classes
+-----------------
+
+The following classes provides the base classes for other items.
+
+.. currentmodule:: silx.gui.plot3d.items.core
+
+:class:`Item3D`
++++++++++++++++
+
+.. autoclass:: Item3D
+ :show-inheritance:
+ :members:
+
+:class:`DataItem3D`
++++++++++++++++++++
+
+:class:`DataItem3D` inherits from :class:`.Item3D` and also provides its API.
+
+.. autoclass:: DataItem3D
+ :show-inheritance:
+ :members:
+
+:class:`GroupItem`
+++++++++++++++++++
+
+:class:`GroupItem` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: GroupItem
+ :show-inheritance:
+ :members:
diff --git a/doc/source/modules/gui/plot3d/scalarfieldview.rst b/doc/source/modules/gui/plot3d/scalarfieldview.rst
index 80127ea..b2e1e67 100644
--- a/doc/source/modules/gui/plot3d/scalarfieldview.rst
+++ b/doc/source/modules/gui/plot3d/scalarfieldview.rst
@@ -5,7 +5,7 @@
.. automodule:: silx.gui.plot3d.ScalarFieldView
-For sample code using ScalarFieldView, see :doc:`viewer3dvolume_example`
+For sample code using ScalarFieldView, see :ref:`plot3d-sample-code`
.. currentmodule:: silx.gui.plot3d.ScalarFieldView
diff --git a/doc/source/modules/gui/plot3d/scenewidget.rst b/doc/source/modules/gui/plot3d/scenewidget.rst
new file mode 100644
index 0000000..5c6f411
--- /dev/null
+++ b/doc/source/modules/gui/plot3d/scenewidget.rst
@@ -0,0 +1,29 @@
+.. currentmodule:: silx.gui.plot3d
+
+:mod:`SceneWidget`: 3D data viewer widget
+=========================================
+
+.. automodule:: silx.gui.plot3d.SceneWidget
+
+.. image:: img/SceneWidget.png
+ :height: 150px
+ :align: center
+
+For sample code using :class:`SceneWidget`, see ``plot3dSceneWindow.py`` in :ref:`plot3d-sample-code`.
+
+.. currentmodule:: silx.gui.plot3d.SceneWidget
+
+:class:`SceneWidget`
+--------------------
+
+.. autoclass:: SceneWidget
+ :show-inheritance:
+ :members:
+
+:class:`SceneWidget` items
+--------------------------
+
+.. toctree::
+ :maxdepth: 2
+
+ items.rst \ No newline at end of file
diff --git a/doc/source/modules/gui/plot3d/scenewindow.rst b/doc/source/modules/gui/plot3d/scenewindow.rst
new file mode 100644
index 0000000..ee6a59b
--- /dev/null
+++ b/doc/source/modules/gui/plot3d/scenewindow.rst
@@ -0,0 +1,22 @@
+.. currentmodule:: silx.gui.plot3d.SceneWindow
+
+
+:mod:`SceneWindow`: 3D data viewer window
+=========================================
+
+.. automodule:: silx.gui.plot3d.SceneWindow
+
+.. image:: img/SceneWindow.png
+ :height: 150px
+ :align: center
+
+For sample code using :class:`SceneWindow`, see ``plot3dSceneWindow.py`` in :ref:`plot3d-sample-code`.
+
+See :class:`~silx.gui.plot3d.SceneWidget.SceneWidget` for the API to manage the visualized 3D data.
+
+:class:`SceneWindow`
+--------------------
+
+.. autoclass:: SceneWindow
+ :show-inheritance:
+ :members:
diff --git a/doc/source/modules/gui/plot3d/viewer3dvolume_example.rst b/doc/source/modules/gui/plot3d/viewer3dvolume_example.rst
deleted file mode 100644
index 5368e05..0000000
--- a/doc/source/modules/gui/plot3d/viewer3dvolume_example.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-viewer3DVolume.py
-=================
-
-Sample code demonstrating :mod:`silx.gui.plot3d.ScalarFieldView` widget:
-
-.. literalinclude:: ../../../../../examples/viewer3DVolume.py
- :lines: 38- \ No newline at end of file