summaryrefslogtreecommitdiff
path: root/silx/gui/plot3d/items/clipplane.py
blob: 3e819d02a14755bdec8519f13fcca718dc32e221 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# 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 scene clip plane class.
"""

from __future__ import absolute_import

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


import numpy

from ..scene import primitives, utils

from ._pick import PickingResult
from .core import Item3D
from .mixins import PlaneMixIn


class ClipPlane(Item3D, PlaneMixIn):
    """Represents a clipping plane that clips following items within the group.

    For now only on clip plane is allowed at once in a scene.
    """

    def __init__(self, parent=None):
        plane = primitives.ClipPlane()
        Item3D.__init__(self, parent=parent, primitive=plane)
        PlaneMixIn.__init__(self, plane=plane)

    def __pickPreProcessing(self, context):
        """Common processing for :meth:`_pickPostProcess` and :meth:`_pickFull`

        :param PickContext context: Current picking context
        :return None or (bounds, intersection points, rayObject)
        """
        plane = self._getPlane()
        planeParent = plane.parent
        if planeParent is None:
            return None

        rayObject = context.getPickingSegment(frame=plane)
        if rayObject is None:
            return None

        bounds = planeParent.bounds(dataBounds=True)
        rayClip = utils.clipSegmentToBounds(rayObject[:, :3], bounds)
        if rayClip is None:
            return None  # Ray is outside parent's bounding box

        points = utils.segmentPlaneIntersect(
            rayObject[0, :3],
            rayObject[1, :3],
            planeNorm=self.getNormal(),
            planePt=self.getPoint())

        # A single intersection inside bounding box
        picked = (len(points) == 1 and
                  numpy.all(bounds[0] <= points[0]) and
                  numpy.all(points[0] <= bounds[1]))

        return picked, points, rayObject

    def _pick(self, context):
        # Perform picking before modifying context
        result = super(ClipPlane, self)._pick(context)

        # Modify context if needed
        if self.isVisible() and context.isEnabled():
            info = self.__pickPreProcessing(context)
            if info is not None:
                picked, points, rayObject = info
                plane = self._getPlane()

                if picked:  # A single intersection inside bounding box
                    # Clip NDC z range for following brother items
                    ndcIntersect = plane.objectToNDCTransform.transformPoint(
                        points[0], perspectiveDivide=True)
                    ndcNormal = plane.objectToNDCTransform.transformNormal(
                        self.getNormal())
                    if ndcNormal[2] < 0:
                        context.setNDCZRange(-1., ndcIntersect[2])
                    else:
                        context.setNDCZRange(ndcIntersect[2], 1.)

                else:
                    # TODO check this might not be correct
                    rayObject[:, 3] = 1.  # Make sure 4h coordinate is one
                    if numpy.sum(rayObject[0] * self.getParameters()) < 0.:
                        # Disable picking for remaining brothers
                        context.setEnabled(False)

        return result

    def _pickFastCheck(self, context):
        return True

    def _pickFull(self, context):
        """Perform picking in this item at given widget position.

        :param PickContext context: Current picking context
        :return: Object holding the results or None
        :rtype: Union[None,PickingResult]
        """
        info = self.__pickPreProcessing(context)
        if info is not None:
            picked, points, _ = info

            if picked:
                return PickingResult(self, positions=[points[0]])

        return None