Code cleanup: unused python vars & imports
[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-80 compliant>
20
21 __all__ = (
22     "region_2d_to_vector_3d",
23     "region_2d_to_origin_3d",
24     "region_2d_to_location_3d",
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 specific 2d region
32     coordinate.
33
34     :arg region: region of the 3D viewport, typically bpy.context.region.
35     :type region: :class:`bpy.types.Region`
36     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
37     :type rv3d: :class:`bpy.types.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:`mathutils.Vector`
43     """
44     from mathutils import Vector
45
46     viewinv = rv3d.view_matrix.inverted()
47     if rv3d.is_perspective:
48         persinv = rv3d.perspective_matrix.inverted()
49
50         out = Vector(((2.0 * coord[0] / region.width) - 1.0,
51                       (2.0 * coord[1] / region.height) - 1.0,
52                       -0.5
53                      ))
54
55         w = out.dot(persinv[3].xyz) + persinv[3][3]
56
57         return ((persinv * out) / w) - viewinv.translation
58     else:
59         return viewinv.col[2].xyz.normalized()
60
61
62 def region_2d_to_origin_3d(region, rv3d, coord):
63     """
64     Return the 3d view origin from the region relative 2d coords.
65
66     :arg region: region of the 3D viewport, typically bpy.context.region.
67     :type region: :class:`bpy.types.Region`
68     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
69     :type rv3d: :class:`bpy.types.RegionView3D`
70     :arg coord: 2d coordinates relative to the region;
71        (event.mouse_region_x, event.mouse_region_y) for example.
72     :type coord: 2d vector
73     :return: The origin of the viewpoint in 3d space.
74     :rtype: :class:`mathutils.Vector`
75     """
76     viewinv = rv3d.view_matrix.inverted()
77
78     if rv3d.is_perspective:
79         origin_start = viewinv.translation.copy()
80     else:
81         persmat = rv3d.perspective_matrix.copy()
82         dx = (2.0 * coord[0] / region.width) - 1.0
83         dy = (2.0 * coord[1] / region.height) - 1.0
84         persinv = persmat.inverted()
85         origin_start = ((persinv.col[0].xyz * dx) +
86                         (persinv.col[1].xyz * dy) +
87                         viewinv.translation)
88     return origin_start
89
90
91 def region_2d_to_location_3d(region, rv3d, coord, depth_location):
92     """
93     Return a 3d location from the region relative 2d coords, aligned with
94     *depth_location*.
95
96     :arg region: region of the 3D viewport, typically bpy.context.region.
97     :type region: :class:`bpy.types.Region`
98     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
99     :type rv3d: :class:`bpy.types.RegionView3D`
100     :arg coord: 2d coordinates relative to the region;
101        (event.mouse_region_x, event.mouse_region_y) for example.
102     :type coord: 2d vector
103     :arg depth_location: the returned vectors depth is aligned with this since
104        there is no defined depth with a 2d region input.
105     :type depth_location: 3d vector
106     :return: normalized 3d vector.
107     :rtype: :class:`mathutils.Vector`
108     """
109     from mathutils import Vector
110
111     coord_vec = region_2d_to_vector_3d(region, rv3d, coord)
112     depth_location = Vector(depth_location)
113
114     origin_start = region_2d_to_origin_3d(region, rv3d, coord)
115     origin_end = origin_start + coord_vec
116
117     if rv3d.is_perspective:
118         from mathutils.geometry import intersect_line_plane
119         viewinv = rv3d.view_matrix.inverted()
120         view_vec = viewinv.col[2].copy()
121         return intersect_line_plane(origin_start,
122                                     origin_end,
123                                     depth_location,
124                                     view_vec, 1,
125                                     )
126     else:
127         from mathutils.geometry import intersect_point_line
128         return intersect_point_line(depth_location,
129                                     origin_start,
130                                     origin_end,
131                                     )[0]
132
133
134 def location_3d_to_region_2d(region, rv3d, coord):
135     """
136     Return the *region* relative 2d location of a 3d position.
137
138     :arg region: region of the 3D viewport, typically bpy.context.region.
139     :type region: :class:`bpy.types.Region`
140     :arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
141     :type rv3d: :class:`bpy.types.RegionView3D`
142     :arg coord: 3d worldspace location.
143     :type coord: 3d vector
144     :return: 2d location
145     :rtype: :class:`mathutils.Vector`
146     """
147     from mathutils import Vector
148
149     prj = rv3d.perspective_matrix * Vector((coord[0], coord[1], coord[2], 1.0))
150     if prj.w > 0.0:
151         width_half = region.width / 2.0
152         height_half = region.height / 2.0
153
154         return Vector((width_half + width_half * (prj.x / prj.w),
155                        height_half + height_half * (prj.y / prj.w),
156                        ))
157     else:
158         return None