merge from trunk #37722
[blender-staging.git] / release / scripts / modules / bpy_extras / view3d_utils.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 __all__ = (
22     "region_2d_to_vector_3d",
23     "region_2d_to_location_3d",
24     "location_3d_to_region_2d",
25     "location_3d_to_region_2d",
26 )
27
28
29 def region_2d_to_vector_3d(region, rv3d, coord):
30     """
31     Return a direction vector from the viewport at the spesific 2d region
32     coordinate.
33
34     :arg region: region of the 3D viewport, typically bpy.context.region.
35     :type region: :class:`Region`
36     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
37     :type rv3d: :class:`RegionView3D`
38     :arg coord: 2d coordinates relative to the region:
39        (event.mouse_region_x, event.mouse_region_y) for example.
40     :type coord: 2d vector
41     :return: normalized 3d vector.
42     :rtype: :class:`Vector`
43     """
44     from mathutils import Vector
45
46     if rv3d.is_perspective:
47         persinv = rv3d.perspective_matrix.inverted()
48
49         out = Vector(((2.0 * coord[0] / region.width) - 1.0,
50                       (2.0 * coord[1] / region.height) - 1.0,
51                       -0.5
52                     ))
53
54         w = (out[0] * persinv[0][3]) + \
55             (out[1] * persinv[1][3]) + \
56             (out[2] * persinv[2][3]) + persinv[3][3]
57
58         return ((out * persinv) / w) - rv3d.view_matrix.inverted()[3].xyz
59     else:
60         return rv3d.view_matrix.inverted()[2].xyz.normalized()
61
62
63 def region_2d_to_location_3d(region, rv3d, coord, depth_location):
64     """
65     Return a 3d location from the region relative 2d coords, aligned with
66     *depth_location*.
67
68     :arg region: region of the 3D viewport, typically bpy.context.region.
69     :type region: :class:`Region`
70     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
71     :type rv3d: :class:`RegionView3D`
72     :arg coord: 2d coordinates relative to the region;
73        (event.mouse_region_x, event.mouse_region_y) for example.
74     :type coord: 2d vector
75     :arg depth_location: the returned vectors depth is aligned with this since
76        there is no defined depth with a 2d region input.
77     :type depth_location: 3d vector
78     :return: normalized 3d vector.
79     :rtype: :class:`Vector`
80     """
81     from mathutils import Vector
82     from mathutils.geometry import intersect_point_line
83
84     persmat = rv3d.perspective_matrix.copy()
85     coord_vec = region_2d_to_vector_3d(region, rv3d, coord)
86     depth_location = Vector(depth_location)
87
88     if rv3d.is_perspective:
89         from mathutils.geometry import intersect_line_plane
90
91         origin_start = rv3d.view_matrix.inverted()[3].to_3d()
92         origin_end = origin_start + coord_vec
93         view_vec = rv3d.view_matrix.inverted()[2]
94         return intersect_line_plane(origin_start, origin_end, depth_location, view_vec, 1)
95     else:
96         dx = (2.0 * coord[0] / region.width) - 1.0
97         dy = (2.0 * coord[1] / region.height) - 1.0
98         persinv = persmat.inverted()
99         viewinv = rv3d.view_matrix.inverted()
100         origin_start = (persinv[0].xyz * dx) + (persinv[1].xyz * dy) + viewinv[3].xyz
101         origin_end = origin_start + coord_vec
102         return intersect_point_line(depth_location, origin_start, origin_end)[0]
103
104
105 def location_3d_to_region_2d(region, rv3d, coord):
106     """
107     Return the *region* relative 2d location of a 3d position.
108
109     :arg region: region of the 3D viewport, typically bpy.context.region.
110     :type region: :class:`Region`
111     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
112     :type rv3d: :class:`RegionView3D`
113     :arg coord: 3d worldspace location.
114     :type coord: 3d vector
115     :return: 2d location
116     :rtype: :class:`Vector`
117     """
118     from mathutils import Vector
119
120     prj = Vector((coord[0], coord[1], coord[2], 1.0)) * rv3d.perspective_matrix
121     if prj.w > 0.0:
122         width_half = region.width / 2.0
123         height_half = region.height / 2.0
124
125         return Vector((width_half + width_half * (prj.x / prj.w),
126                        height_half + height_half * (prj.y / prj.w),
127                        ))
128     else:
129         return None