ef2e20c4908e15de138ede813be49621927bac95
[blender.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
22 def region_2d_to_vector_3d(region, rv3d, coord):
23     """
24     Return a direction vector from the viewport at the spesific 2d region
25     coordinate.
26
27     :arg region: region of the 3D viewport, typically bpy.context.region.
28     :type region: :class:`Region`
29     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
30     :type rv3d: :class:`RegionView3D`
31     :arg coord: 2d coordinates relative to the region;
32        (event.mouse_region_x, event.mouse_region_y) for example.
33     :type coord: 2d vector
34     :return: normalized 3d vector.
35     :rtype: :class:`Vector`
36     """
37     from mathutils import Vector
38
39     if rv3d.is_perspective:
40         persinv = rv3d.perspective_matrix.inverted()
41
42         out = Vector(((2.0 * coord[0] / region.width) - 1.0,
43                       (2.0 * coord[1] / region.height) - 1.0,
44                       -0.5
45                     ))        
46
47         w = (out[0] * persinv[0][3]) + (out[1] * persinv[1][3]) + (out[2] * persinv[2][3]) + persinv[3][3]
48
49         return ((out * persinv) / w) - rv3d.view_matrix.inverted()[3].xyz
50     else:
51         return rv3d.view_matrix.inverted()[2].xyz.normalized()
52
53
54 def region_2d_to_location_3d(region, rv3d, coord, depth_location):
55     """
56     Return a 3d location from the region relative 2d coords, aligned with
57     *depth_location*.
58
59     :arg region: region of the 3D viewport, typically bpy.context.region.
60     :type region: :class:`Region`
61     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
62     :type rv3d: :class:`RegionView3D`
63     :arg coord: 2d coordinates relative to the region;
64        (event.mouse_region_x, event.mouse_region_y) for example.
65     :type coord: 2d vector
66     :arg depth_location: the returned vectors depth is aligned with this since
67        there is no defined depth with a 2d region input.
68     :type depth_location: 3d vector
69     :return: normalized 3d vector.
70     :rtype: :class:`Vector`
71     """
72     from mathutils import Vector
73     from mathutils.geometry import intersect_point_line
74
75     persmat = rv3d.perspective_matrix.copy()
76     coord_vec = region_2d_to_vector_3d(region, rv3d, coord)
77     depth_location = Vector(depth_location)
78
79     if rv3d.is_perspective:
80         from mathutils.geometry import intersect_line_plane
81
82         origin_start = rv3d.view_matrix.inverted()[3].to_3d()
83         origin_end = origin_start + coord_vec
84         view_vec = rv3d.view_matrix.inverted()[2]
85         return intersect_line_plane(origin_start, origin_end, depth_location, view_vec, 1)
86     else:
87         dx = (2.0 * coord[0] / region.width) - 1.0
88         dy = (2.0 * coord[1] / region.height) - 1.0
89         persinv = persmat.inverted()
90         viewinv = rv3d.view_matrix.inverted()
91         origin_start = (persinv[0].xyz * dx) + (persinv[1].xyz * dy) + viewinv[3].xyz
92         origin_end = origin_start + coord_vec
93         return intersect_point_line(depth_location, origin_start, origin_end)[0]
94
95
96 def location_3d_to_region_2d(region, rv3d, coord):
97     """
98     Return the *region* relative 2d location of a 3d position.
99
100     :arg region: region of the 3D viewport, typically bpy.context.region.
101     :type region: :class:`Region`
102     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
103     :type rv3d: :class:`RegionView3D`
104     :arg coord: 3d worldspace location.
105     :type coord: 3d vector
106     :return: 2d location
107     :rtype: :class:`Vector`
108     """
109     prj = Vector((coord[0], coord[1], coord[2], 1.0)) * rv3d.perspective_matrix
110     if prj.w > 0.0:
111         width_half = region.width / 2.0
112         height_half = region.height / 2.0
113
114         return Vector((width_half + width_half * (prj.x / prj.w),
115                        height_half + height_half * (prj.y / prj.w),
116                        ))
117     else:
118         return None