Source code for silx.gui.plot3d.SceneWindow

# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2017-2018 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""This module provides a QMainWindow with a 3D SceneWidget and toolbars.
"""

from __future__ import absolute_import

__authors__ = ["T. Vincent"]
__license__ = "MIT"
__date__ = "29/11/2017"


from ...gui import qt, icons

from .actions.mode import InteractiveModeAction
from .SceneWidget import SceneWidget
from .tools import OutputToolBar, InteractiveModeToolBar, ViewpointToolBar
from .tools.GroupPropertiesWidget import GroupPropertiesWidget

from .ParamTreeView import ParamTreeView

# Imported here for convenience
from . import items  # noqa


__all__ = ['items', 'SceneWidget', 'SceneWindow']


class _PanPlaneAction(InteractiveModeAction):
    """QAction to set plane pan interaction on a Plot3DWidget

    :param parent: See :class:`QAction`
    :param ~silx.gui.plot3d.Plot3DWidget.Plot3DWidget plot3d:
        Plot3DWidget the action is associated with
    """
    def __init__(self, parent, plot3d=None):
        super(_PanPlaneAction, self).__init__(
            parent, 'panSelectedPlane', plot3d)
        self.setIcon(icons.getQIcon('3d-plane-pan'))
        self.setText('Pan plane')
        self.setCheckable(True)
        self.setToolTip(
            'Pan selected plane. Press <b>Ctrl</b> to rotate the scene.')

    def _planeChanged(self, event):
        """Handle plane updates"""
        if event in (items.ItemChangedType.VISIBLE,
                     items.ItemChangedType.POSITION):
            plane = self.sender()

            isPlaneInteractive = \
                plane._getPlane().plane.isPlane and plane.isVisible()

            if isPlaneInteractive != self.isEnabled():
                self.setEnabled(isPlaneInteractive)
                mode = 'panSelectedPlane' if isPlaneInteractive else 'rotate'
                self.getPlot3DWidget().setInteractiveMode(mode)

    def _selectionChanged(self, current, previous):
        """Handle selected object change"""
        if isinstance(previous, items.PlaneMixIn):
            previous.sigItemChanged.disconnect(self._planeChanged)

        if isinstance(current, items.PlaneMixIn):
            current.sigItemChanged.connect(self._planeChanged)
            self.setEnabled(True)
            self.getPlot3DWidget().setInteractiveMode('panSelectedPlane')
        else:
            self.setEnabled(False)

    def setPlot3DWidget(self, widget):
        previous = self.getPlot3DWidget()
        if isinstance(previous, SceneWidget):
            previous.selection().sigCurrentChanged.disconnect(
                self._selectionChanged)
            self._selectionChanged(
                None, previous.selection().getCurrentItem())

        super(_PanPlaneAction, self).setPlot3DWidget(widget)

        if isinstance(widget, SceneWidget):
            self._selectionChanged(widget.selection().getCurrentItem(), None)
            widget.selection().sigCurrentChanged.connect(
                self._selectionChanged)


[docs]class SceneWindow(qt.QMainWindow): """OpenGL 3D scene widget with toolbars.""" def __init__(self, parent=None): super(SceneWindow, self).__init__(parent) if parent is not None: # behave as a widget self.setWindowFlags(qt.Qt.Widget) self._sceneWidget = SceneWidget() self.setCentralWidget(self._sceneWidget) self._interactiveModeToolBar = InteractiveModeToolBar(parent=self) panPlaneAction = _PanPlaneAction(self, plot3d=self._sceneWidget) self._interactiveModeToolBar.addAction(panPlaneAction) self._viewpointToolBar = ViewpointToolBar(parent=self) self._outputToolBar = OutputToolBar(parent=self) for toolbar in (self._interactiveModeToolBar, self._viewpointToolBar, self._outputToolBar): toolbar.setPlot3DWidget(self._sceneWidget) self.addToolBar(toolbar) self.addActions(toolbar.actions()) self._paramTreeView = ParamTreeView() self._paramTreeView.setModel(self._sceneWidget.model()) selectionModel = self._paramTreeView.selectionModel() self._sceneWidget.selection()._setSyncSelectionModel( selectionModel) paramDock = qt.QDockWidget() paramDock.setWindowTitle('Object parameters') paramDock.setWidget(self._paramTreeView) self.addDockWidget(qt.Qt.RightDockWidgetArea, paramDock) self._sceneGroupResetWidget = GroupPropertiesWidget() self._sceneGroupResetWidget.setGroup( self._sceneWidget.getSceneGroup()) resetDock = qt.QDockWidget() resetDock.setWindowTitle('Global parameters') resetDock.setWidget(self._sceneGroupResetWidget) self.addDockWidget(qt.Qt.RightDockWidgetArea, resetDock) self.tabifyDockWidget(paramDock, resetDock) paramDock.raise_()
[docs] def getSceneWidget(self): """Returns the SceneWidget of this window. :rtype: ~silx.gui.plot3d.SceneWidget.SceneWidget """ return self._sceneWidget
[docs] def getGroupResetWidget(self): """Returns the :class:`GroupPropertiesWidget` of this window. :rtype: GroupPropertiesWidget """ return self._sceneGroupResetWidget
[docs] def getParamTreeView(self): """Returns the :class:`ParamTreeView` of this window. :rtype: ParamTreeView """ return self._paramTreeView
[docs] def getInteractiveModeToolBar(self): """Returns the interactive mode toolbar. :rtype: ~silx.gui.plot3d.tools.InteractiveModeToolBar """ return self._interactiveModeToolBar
[docs] def getViewpointToolBar(self): """Returns the viewpoint toolbar. :rtype: ~silx.gui.plot3d.tools.ViewpointToolBar """ return self._viewpointToolBar
[docs] def getOutputToolBar(self): """Returns the output toolbar. :rtype: ~silx.gui.plot3d.tools.OutputToolBar """ return self._outputToolBar