summaryrefslogtreecommitdiff
path: root/doc/source/modules/gui/plot3d/scenewindow.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/gui/plot3d/scenewindow.rst')
-rw-r--r--doc/source/modules/gui/plot3d/scenewindow.rst22
1 files changed, 22 insertions, 0 deletions
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: