3D View: add a simple un-clipped win_to_ray
[blender.git] / source / blender / editors / space_view3d / view3d_project.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_view3d/view3d_project.c
28  *  \ingroup spview3d
29  */
30
31 #include "DNA_camera_types.h"
32 #include "DNA_object_types.h"
33 #include "DNA_screen_types.h"
34 #include "DNA_scene_types.h"
35 #include "DNA_view3d_types.h"
36
37 #include "BLI_sys_types.h"  /* int64_t */
38
39 #include "BIF_gl.h"  /* bglMats */
40 #include "BIF_glutil.h"  /* bglMats */
41
42 #include "BLI_math_vector.h"
43
44 #include "BKE_camera.h"
45 #include "BKE_screen.h"
46
47 #include "ED_view3d.h"  /* own include */
48
49 #define BL_NEAR_CLIP 0.001
50 #define BL_ZERO_CLIP 0.001
51
52 /* Non Clipping Projection Functions
53  * ********************************* */
54
55 /**
56  * \note use #ED_view3d_ob_project_mat_get to get the projection matrix
57  */
58 void ED_view3d_project_float_v2_m4(const ARegion *ar, const float co[3], float r_co[2], float mat[4][4])
59 {
60         float vec4[4];
61
62         copy_v3_v3(vec4, co);
63         vec4[3] = 1.0;
64         /* r_co[0] = IS_CLIPPED; */ /* always overwritten */
65
66         mul_m4_v4(mat, vec4);
67
68         if (vec4[3] > FLT_EPSILON) {
69                 r_co[0] = (float)(ar->winx / 2.0f) + (ar->winx / 2.0f) * vec4[0] / vec4[3];
70                 r_co[1] = (float)(ar->winy / 2.0f) + (ar->winy / 2.0f) * vec4[1] / vec4[3];
71         }
72         else {
73                 zero_v2(r_co);
74         }
75 }
76
77 /**
78  * \note use #ED_view3d_ob_project_mat_get to get projecting mat
79  */
80 void ED_view3d_project_float_v3_m4(const ARegion *ar, const float vec[3], float r_co[3], float mat[4][4])
81 {
82         float vec4[4];
83
84         copy_v3_v3(vec4, vec);
85         vec4[3] = 1.0;
86         /* r_co[0] = IS_CLIPPED; */ /* always overwritten */
87
88         mul_m4_v4(mat, vec4);
89
90         if (vec4[3] > FLT_EPSILON) {
91                 r_co[0] = (float)(ar->winx / 2.0f) + (ar->winx / 2.0f) * vec4[0] / vec4[3];
92                 r_co[1] = (float)(ar->winy / 2.0f) + (ar->winy / 2.0f) * vec4[1] / vec4[3];
93                 r_co[2] = vec4[2] / vec4[3];
94         }
95         else {
96                 zero_v3(r_co);
97         }
98 }
99
100
101 /* Clipping Projection Functions
102  * ***************************** */
103
104 eV3DProjStatus ED_view3d_project_base(const struct ARegion *ar, struct Base *base)
105 {
106         eV3DProjStatus ret = ED_view3d_project_short_global(ar, base->object->obmat[3], &base->sx, V3D_PROJ_TEST_CLIP_DEFAULT);
107
108         if (ret != V3D_PROJ_RET_OK) {
109                 base->sx = IS_CLIPPED;
110                 base->sy = 0;
111         }
112
113         return ret;
114 }
115
116 /* perspmat is typically...
117  * - 'rv3d->perspmat',   is_local == false
118  * - 'rv3d->persmatob', is_local == true
119  */
120 static eV3DProjStatus ed_view3d_project__internal(const ARegion *ar,
121                                                   float perspmat[4][4], const bool is_local,  /* normally hidden */
122                                                   const float co[3], float r_co[2], const eV3DProjTest flag)
123 {
124         float vec4[4];
125
126         /* check for bad flags */
127         BLI_assert((flag & V3D_PROJ_TEST_ALL) == flag);
128
129         if (flag & V3D_PROJ_TEST_CLIP_BB) {
130                 RegionView3D *rv3d = ar->regiondata;
131                 if (rv3d->rflag & RV3D_CLIPPING) {
132                         if (ED_view3d_clipping_test(rv3d, co, is_local)) {
133                                 return V3D_PROJ_RET_CLIP_BB;
134                         }
135                 }
136         }
137
138         copy_v3_v3(vec4, co);
139         vec4[3] = 1.0;
140         mul_m4_v4(perspmat, vec4);
141
142
143
144         if (((flag & V3D_PROJ_TEST_CLIP_ZERO) == 0) || (fabsf(vec4[3]) > (float)BL_ZERO_CLIP)) {
145                 if (((flag & V3D_PROJ_TEST_CLIP_NEAR) == 0)  || (vec4[3] > (float)BL_NEAR_CLIP)) {
146                         const float scalar = (vec4[3] != 0.0f) ? (1.0f / vec4[3]) : 0.0f;
147                         const float fx = ((float)ar->winx / 2.0f) * (1.0f + (vec4[0] * scalar));
148                         if (((flag & V3D_PROJ_TEST_CLIP_WIN) == 0) || (fx > 0.0f && fx < (float)ar->winx)) {
149                                 const float fy = ((float)ar->winy / 2.0f) * (1.0f + (vec4[1] * scalar));
150                                 if (((flag & V3D_PROJ_TEST_CLIP_WIN) == 0) || (fy > 0.0f && fy < (float)ar->winy)) {
151                                         r_co[0] = fx;
152                                         r_co[1] = fy;
153
154                                         /* check if the point is behind the view, we need to flip in this case */
155                                         if (UNLIKELY((flag & V3D_PROJ_TEST_CLIP_NEAR) == 0) && (vec4[3] < 0.0f)) {
156                                                 negate_v2(r_co);
157                                         }
158                                 }
159                                 else {
160                                         return V3D_PROJ_RET_CLIP_WIN;
161                                 }
162                         }
163                         else {
164                                 return V3D_PROJ_RET_CLIP_WIN;
165                         }
166                 }
167                 else {
168                         return V3D_PROJ_RET_CLIP_NEAR;
169                 }
170         }
171         else {
172                 return V3D_PROJ_RET_CLIP_ZERO;
173         }
174
175         return V3D_PROJ_RET_OK;
176 }
177
178 eV3DProjStatus ED_view3d_project_short_ex(const ARegion *ar, float perspmat[4][4], const bool is_local,
179                                           const float co[3], short r_co[2], const eV3DProjTest flag)
180 {
181         float tvec[2];
182         eV3DProjStatus ret = ed_view3d_project__internal(ar, perspmat, is_local, co, tvec, flag);
183         if (ret == V3D_PROJ_RET_OK) {
184                 if ((tvec[0] > -32700.0f && tvec[0] < 32700.0f) &&
185                     (tvec[1] > -32700.0f && tvec[1] < 32700.0f))
186                 {
187                         r_co[0] = (short)floorf(tvec[0]);
188                         r_co[1] = (short)floorf(tvec[1]);
189                 }
190                 else {
191                         ret = V3D_PROJ_RET_OVERFLOW;
192                 }
193         }
194         return ret;
195 }
196
197 eV3DProjStatus ED_view3d_project_int_ex(const ARegion *ar, float perspmat[4][4], const bool is_local,
198                                         const float co[3], int r_co[2], const eV3DProjTest flag)
199 {
200         float tvec[2];
201         eV3DProjStatus ret = ed_view3d_project__internal(ar, perspmat, is_local, co, tvec, flag);
202         if (ret == V3D_PROJ_RET_OK) {
203                 if ((tvec[0] > -2140000000.0f && tvec[0] < 2140000000.0f) &&
204                     (tvec[1] > -2140000000.0f && tvec[1] < 2140000000.0f))
205                 {
206                         r_co[0] = (int)floorf(tvec[0]);
207                         r_co[1] = (int)floorf(tvec[1]);
208                 }
209                 else {
210                         ret = V3D_PROJ_RET_OVERFLOW;
211                 }
212         }
213         return ret;
214 }
215
216 eV3DProjStatus ED_view3d_project_float_ex(const ARegion *ar, float perspmat[4][4], const bool is_local,
217                                         const float co[3], float r_co[2], const eV3DProjTest flag)
218 {
219         float tvec[2];
220         eV3DProjStatus ret = ed_view3d_project__internal(ar, perspmat, is_local, co, tvec, flag);
221         if (ret == V3D_PROJ_RET_OK) {
222                 if (isfinite(tvec[0]) &&
223                     isfinite(tvec[1]))
224                 {
225                         copy_v2_v2(r_co, tvec);
226                 }
227                 else {
228                         ret = V3D_PROJ_RET_OVERFLOW;
229                 }
230         }
231         return ret;
232 }
233
234 /* --- short --- */
235 eV3DProjStatus ED_view3d_project_short_global(const ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag)
236 {
237         RegionView3D *rv3d = ar->regiondata;
238         return ED_view3d_project_short_ex(ar, rv3d->persmat, false, co, r_co, flag);
239 }
240 /* object space, use ED_view3d_init_mats_rv3d before calling */
241 eV3DProjStatus ED_view3d_project_short_object(const ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag)
242 {
243         RegionView3D *rv3d = ar->regiondata;
244         ED_view3d_check_mats_rv3d(rv3d);
245         return ED_view3d_project_short_ex(ar, rv3d->persmatob, true, co, r_co, flag);
246 }
247
248 /* --- int --- */
249 eV3DProjStatus ED_view3d_project_int_global(const ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag)
250 {
251         RegionView3D *rv3d = ar->regiondata;
252         return ED_view3d_project_int_ex(ar, rv3d->persmat, false, co, r_co, flag);
253 }
254 /* object space, use ED_view3d_init_mats_rv3d before calling */
255 eV3DProjStatus ED_view3d_project_int_object(const ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag)
256 {
257         RegionView3D *rv3d = ar->regiondata;
258         ED_view3d_check_mats_rv3d(rv3d);
259         return ED_view3d_project_int_ex(ar, rv3d->persmatob, true, co, r_co, flag);
260 }
261
262 /* --- float --- */
263 eV3DProjStatus ED_view3d_project_float_global(const ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag)
264 {
265         RegionView3D *rv3d = ar->regiondata;
266         return ED_view3d_project_float_ex(ar, rv3d->persmat, false, co, r_co, flag);
267 }
268 /* object space, use ED_view3d_init_mats_rv3d before calling */
269 eV3DProjStatus ED_view3d_project_float_object(const ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag)
270 {
271         RegionView3D *rv3d = ar->regiondata;
272         ED_view3d_check_mats_rv3d(rv3d);
273         return ED_view3d_project_float_ex(ar, rv3d->persmatob, true, co, r_co, flag);
274 }
275
276
277
278 /* More Generic Window/Ray/Vector projection functions
279  * *************************************************** */
280
281 float ED_view3d_pixel_size(const RegionView3D *rv3d, const float co[3])
282 {
283         return mul_project_m4_v3_zfac((float(*)[4])rv3d->persmat, co) * rv3d->pixsize * U.pixelsize;
284 }
285
286 float ED_view3d_pixel_size_no_ui_scale(const RegionView3D *rv3d, const float co[3])
287 {
288         return mul_project_m4_v3_zfac((float(*)[4])rv3d->persmat, co) * rv3d->pixsize;
289 }
290
291 /**
292  * Calculate a depth value from \a co, use with #ED_view3d_win_to_delta
293  */
294 float ED_view3d_calc_zfac(const RegionView3D *rv3d, const float co[3], bool *r_flip)
295 {
296         float zfac = mul_project_m4_v3_zfac((float (*)[4])rv3d->persmat, co);
297
298         if (r_flip) {
299                 *r_flip = (zfac < 0.0f);
300         }
301
302         /* if x,y,z is exactly the viewport offset, zfac is 0 and we don't want that
303          * (accounting for near zero values) */
304         if (zfac < 1.e-6f && zfac > -1.e-6f) {
305                 zfac = 1.0f;
306         }
307
308         /* Negative zfac means x, y, z was behind the camera (in perspective).
309          * This gives flipped directions, so revert back to ok default case. */
310         if (zfac < 0.0f) {
311                 zfac = -zfac;
312         }
313
314         return zfac;
315 }
316
317 static void view3d_win_to_ray_segment(
318         const ARegion *ar, const View3D *v3d, const float mval[2],
319         float r_ray_co[3], float r_ray_dir[3], float r_ray_start[3], float r_ray_end[3])
320 {
321         RegionView3D *rv3d = ar->regiondata;
322         float _ray_co[3], _ray_dir[3], start_offset, end_offset;
323
324         if (!r_ray_co) r_ray_co = _ray_co;
325         if (!r_ray_dir) r_ray_dir = _ray_dir;
326
327         ED_view3d_win_to_origin(ar, mval, r_ray_co);
328         ED_view3d_win_to_vector(ar, mval, r_ray_dir);
329
330         if ((rv3d->is_persp == false) && (rv3d->persp != RV3D_CAMOB)) {
331                 end_offset = v3d->far / 2.0f;
332                 start_offset = -end_offset;
333         }
334         else {
335                 ED_view3d_clip_range_get(v3d, rv3d, &start_offset, &end_offset, false);
336         }
337
338         if (r_ray_start) {
339                 madd_v3_v3v3fl(r_ray_start, r_ray_co, r_ray_dir, start_offset);
340         }
341         if (r_ray_end) {
342                 madd_v3_v3v3fl(r_ray_end, r_ray_co, r_ray_dir, end_offset);
343         }
344 }
345
346 bool ED_view3d_clip_segment(const RegionView3D *rv3d, float ray_start[3], float ray_end[3])
347 {
348         if ((rv3d->rflag & RV3D_CLIPPING) &&
349             (clip_segment_v3_plane_n(ray_start, ray_end, rv3d->clip, 6,
350                                      ray_start, ray_end) == false))
351         {
352                 return false;
353         }
354         return true;
355 }
356
357 /**
358  * Calculate a 3d viewpoint and direction vector from 2d window coordinates.
359  * This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
360  * ray_start is clipped by the view near limit so points in front of it are always in view.
361  * In orthographic view the resulting ray_normal will match the view vector.
362  * This version also returns the ray_co point of the ray on window plane, useful to fix precision
363  * issues esp. with ortho view, where default ray_start is set rather far away.
364  * \param ar The region (used for the window width and height).
365  * \param v3d The 3d viewport (used for near clipping value).
366  * \param mval The area relative 2d location (such as event->mval, converted into float[2]).
367  * \param r_ray_co The world-space point where the ray intersects the window plane.
368  * \param r_ray_normal The normalized world-space direction of towards mval.
369  * \param r_ray_start The world-space starting point of the ray.
370  * \param do_clip_planes Optionally clip the start of the ray by the view clipping planes.
371  * \return success, false if the ray is totally clipped.
372  */
373 bool ED_view3d_win_to_ray_clipped_ex(
374         const ARegion *ar, const View3D *v3d, const float mval[2],
375         float r_ray_co[3], float r_ray_normal[3], float r_ray_start[3], bool do_clip_planes)
376 {
377         float ray_end[3];
378
379         view3d_win_to_ray_segment(ar, v3d, mval, r_ray_co, r_ray_normal, r_ray_start, ray_end);
380
381         /* bounds clipping */
382         if (do_clip_planes) {
383                 return ED_view3d_clip_segment(ar->regiondata, r_ray_start, ray_end);
384         }
385
386         return true;
387 }
388
389 /**
390  * Calculate a 3d viewpoint and direction vector from 2d window coordinates.
391  * This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
392  * ray_start is clipped by the view near limit so points in front of it are always in view.
393  * In orthographic view the resulting ray_normal will match the view vector.
394  * \param ar The region (used for the window width and height).
395  * \param v3d The 3d viewport (used for near clipping value).
396  * \param mval The area relative 2d location (such as event->mval, converted into float[2]).
397  * \param r_ray_start The world-space point where the ray intersects the window plane.
398  * \param r_ray_normal The normalized world-space direction of towards mval.
399  * \param do_clip_planes Optionally clip the start of the ray by the view clipping planes.
400  * \return success, false if the ray is totally clipped.
401  */
402 bool ED_view3d_win_to_ray_clipped(
403         const ARegion *ar, const View3D *v3d, const float mval[2],
404         float r_ray_start[3], float r_ray_normal[3], const bool do_clip_planes)
405 {
406         return ED_view3d_win_to_ray_clipped_ex(ar, v3d, mval, NULL, r_ray_normal, r_ray_start, do_clip_planes);
407 }
408
409 /**
410  * Calculate a 3d viewpoint and direction vector from 2d window coordinates.
411  * This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
412  * \param ar The region (used for the window width and height).
413  * \param mval The area relative 2d location (such as event->mval, converted into float[2]).
414  * \param r_ray_start The world-space point where the ray intersects the window plane.
415  * \param r_ray_normal The normalized world-space direction of towards mval.
416  *
417  * \note Ignores view near/far clipping, to take this into account use #ED_view3d_win_to_ray_clipped.
418  */
419 void ED_view3d_win_to_ray(
420         const ARegion *ar, const float mval[2],
421         float r_ray_start[3], float r_ray_normal[3])
422 {
423         ED_view3d_win_to_origin(ar, mval, r_ray_start);
424         ED_view3d_win_to_vector(ar, mval, r_ray_normal);
425 }
426
427 /**
428  * Calculate a normalized 3d direction vector from the viewpoint towards a global location.
429  * In orthographic view the resulting vector will match the view vector.
430  * \param rv3d The region (used for the window width and height).
431  * \param coord The world-space location.
432  * \param vec The resulting normalized vector.
433  */
434 void ED_view3d_global_to_vector(const RegionView3D *rv3d, const float coord[3], float vec[3])
435 {
436         if (rv3d->is_persp) {
437                 float p1[4], p2[4];
438
439                 copy_v3_v3(p1, coord);
440                 p1[3] = 1.0f;
441                 copy_v3_v3(p2, p1);
442                 p2[3] = 1.0f;
443                 mul_m4_v4((float (*)[4])rv3d->viewmat, p2);
444
445                 mul_v3_fl(p2, 2.0f);
446
447                 mul_m4_v4((float (*)[4])rv3d->viewinv, p2);
448
449                 sub_v3_v3v3(vec, p1, p2);
450         }
451         else {
452                 copy_v3_v3(vec, rv3d->viewinv[2]);
453         }
454         normalize_v3(vec);
455 }
456
457 /* very similar to ED_view3d_win_to_3d() but has no advantage, de-duplicating */
458 #if 0
459 bool view3d_get_view_aligned_coordinate(ARegion *ar, float fp[3], const int mval[2], const bool do_fallback)
460 {
461         RegionView3D *rv3d = ar->regiondata;
462         float dvec[3];
463         int mval_cpy[2];
464         eV3DProjStatus ret;
465
466         ret = ED_view3d_project_int_global(ar, fp, mval_cpy, V3D_PROJ_TEST_NOP);
467
468         if (ret == V3D_PROJ_RET_OK) {
469                 const float mval_f[2] = {(float)(mval_cpy[0] - mval[0]),
470                                          (float)(mval_cpy[1] - mval[1])};
471                 const float zfac = ED_view3d_calc_zfac(rv3d, fp, NULL);
472                 ED_view3d_win_to_delta(ar, mval_f, dvec, zfac);
473                 sub_v3_v3(fp, dvec);
474
475                 return true;
476         }
477         else {
478                 /* fallback to the view center */
479                 if (do_fallback) {
480                         negate_v3_v3(fp, rv3d->ofs);
481                         return view3d_get_view_aligned_coordinate(ar, fp, mval, false);
482                 }
483                 else {
484                         return false;
485                 }
486         }
487 }
488 #endif
489
490 /**
491  * Calculate a 3d location from 2d window coordinates.
492  * \param ar The region (used for the window width and height).
493  * \param depth_pt The reference location used to calculate the Z depth.
494  * \param mval The area relative location (such as event->mval converted to floats).
495  * \param r_out The resulting world-space location.
496  */
497 void ED_view3d_win_to_3d(
498         const View3D *v3d, const ARegion *ar,
499         const float depth_pt[3], const float mval[2],
500         float r_out[3])
501 {
502         RegionView3D *rv3d = ar->regiondata;
503
504         float ray_origin[3];
505         float ray_direction[3];
506         float lambda;
507
508         if (rv3d->is_persp) {
509                 float plane[4];
510
511                 copy_v3_v3(ray_origin, rv3d->viewinv[3]);
512                 ED_view3d_win_to_vector(ar, mval, ray_direction);
513
514                 /* note, we could use isect_line_plane_v3() however we want the intersection to be infront of the
515                  * view no matter what, so apply the unsigned factor instead */
516                 plane_from_point_normal_v3(plane, depth_pt, rv3d->viewinv[2]);
517
518                 isect_ray_plane_v3(ray_origin, ray_direction, plane, &lambda, false);
519                 lambda = fabsf(lambda);
520         }
521         else {
522                 float dx = (2.0f * mval[0] / (float)ar->winx) - 1.0f;
523                 float dy = (2.0f * mval[1] / (float)ar->winy) - 1.0f;
524
525                 if (rv3d->persp == RV3D_CAMOB) {
526                         /* ortho camera needs offset applied */
527                         const Camera *cam = v3d->camera->data;
528                         const int sensor_fit = BKE_camera_sensor_fit(cam->sensor_fit, ar->winx, ar->winy);
529                         const float zoomfac = BKE_screen_view3d_zoom_to_fac(rv3d->camzoom) * 4.0f;
530                         const float aspx = ar->winx / (float)ar->winy;
531                         const float aspy = ar->winy / (float)ar->winx;
532                         const float shiftx = cam->shiftx * 0.5f * (sensor_fit == CAMERA_SENSOR_FIT_HOR ? 1.0f : aspy);
533                         const float shifty = cam->shifty * 0.5f * (sensor_fit == CAMERA_SENSOR_FIT_HOR ? aspx : 1.0f);
534
535                         dx += (rv3d->camdx + shiftx) * zoomfac;
536                         dy += (rv3d->camdy + shifty) * zoomfac;
537                 }
538                 ray_origin[0] = (rv3d->persinv[0][0] * dx) + (rv3d->persinv[1][0] * dy) + rv3d->viewinv[3][0];
539                 ray_origin[1] = (rv3d->persinv[0][1] * dx) + (rv3d->persinv[1][1] * dy) + rv3d->viewinv[3][1];
540                 ray_origin[2] = (rv3d->persinv[0][2] * dx) + (rv3d->persinv[1][2] * dy) + rv3d->viewinv[3][2];
541
542                 copy_v3_v3(ray_direction, rv3d->viewinv[2]);
543                 lambda = ray_point_factor_v3(depth_pt, ray_origin, ray_direction);
544         }
545
546         madd_v3_v3v3fl(r_out, ray_origin, ray_direction, lambda);
547 }
548
549 void ED_view3d_win_to_3d_int(
550         const View3D *v3d, const ARegion *ar,
551         const float depth_pt[3], const int mval[2],
552         float r_out[3])
553 {
554         const float mval_fl[2] = {mval[0], mval[1]};
555         ED_view3d_win_to_3d(v3d, ar, depth_pt, mval_fl, r_out);
556 }
557
558 bool ED_view3d_win_to_3d_on_plane(
559         const ARegion *ar,
560         const float plane[4], const float mval[2],
561         float r_out[3])
562 {
563         float ray_co[3], ray_no[3];
564         ED_view3d_win_to_origin(ar, mval, ray_co);
565         ED_view3d_win_to_vector(ar, mval, ray_no);
566         float lambda;
567         if (isect_ray_plane_v3(ray_co, ray_no, plane, &lambda, false)) {
568                 madd_v3_v3v3fl(r_out, ray_co, ray_no, lambda);
569                 return true;
570         }
571         return false;
572 }
573
574 bool ED_view3d_win_to_3d_on_plane_int(
575         const ARegion *ar,
576         const float plane[4], const int mval[2],
577         float r_out[3])
578 {
579         const float mval_fl[2] = {mval[0], mval[1]};
580         return ED_view3d_win_to_3d_on_plane(ar, plane, mval_fl, r_out);
581 }
582
583 /**
584  * Calculate a 3d difference vector from 2d window offset.
585  * note that ED_view3d_calc_zfac() must be called first to determine
586  * the depth used to calculate the delta.
587  * \param ar The region (used for the window width and height).
588  * \param mval The area relative 2d difference (such as event->mval[0] - other_x).
589  * \param out The resulting world-space delta.
590  */
591 void ED_view3d_win_to_delta(const ARegion *ar, const float mval[2], float out[3], const float zfac)
592 {
593         RegionView3D *rv3d = ar->regiondata;
594         float dx, dy;
595
596         dx = 2.0f * mval[0] * zfac / ar->winx;
597         dy = 2.0f * mval[1] * zfac / ar->winy;
598
599         out[0] = (rv3d->persinv[0][0] * dx + rv3d->persinv[1][0] * dy);
600         out[1] = (rv3d->persinv[0][1] * dx + rv3d->persinv[1][1] * dy);
601         out[2] = (rv3d->persinv[0][2] * dx + rv3d->persinv[1][2] * dy);
602 }
603
604 /**
605  * Calculate a 3d origin from 2d window coordinates.
606  * \note Orthographic views have a less obvious origin,
607  * Since far clip can be a very large value resulting in numeric precision issues,
608  * the origin in this case is close to zero coordinate.
609  *
610  * \param ar The region (used for the window width and height).
611  * \param mval The area relative 2d location (such as event->mval converted to floats).
612  * \param out The resulting normalized world-space direction vector.
613  */
614 void ED_view3d_win_to_origin(const ARegion *ar, const float mval[2], float out[3])
615 {
616         RegionView3D *rv3d = ar->regiondata;
617         if (rv3d->is_persp) {
618                 copy_v3_v3(out, rv3d->viewinv[3]);
619         }
620         else {
621                 out[0] = 2.0f * mval[0] / ar->winx - 1.0f;
622                 out[1] = 2.0f * mval[1] / ar->winy - 1.0f;
623
624                 if (rv3d->persp == RV3D_CAMOB) {
625                         out[2] = -1.0f;
626                 }
627                 else {
628                         out[2] = 0.0f;
629                 }
630
631                 mul_project_m4_v3(rv3d->persinv, out);
632         }
633 }
634
635 /**
636  * Calculate a 3d direction vector from 2d window coordinates.
637  * This direction vector starts and the view in the direction of the 2d window coordinates.
638  * In orthographic view all window coordinates yield the same vector.
639  *
640  * \note doesn't rely on ED_view3d_calc_zfac
641  * for perspective view, get the vector direction to
642  * the mouse cursor as a normalized vector.
643  *
644  * \param ar The region (used for the window width and height).
645  * \param mval The area relative 2d location (such as event->mval converted to floats).
646  * \param out The resulting normalized world-space direction vector.
647  */
648 void ED_view3d_win_to_vector(const ARegion *ar, const float mval[2], float out[3])
649 {
650         RegionView3D *rv3d = ar->regiondata;
651
652         if (rv3d->is_persp) {
653                 out[0] = 2.0f * (mval[0] / ar->winx) - 1.0f;
654                 out[1] = 2.0f * (mval[1] / ar->winy) - 1.0f;
655                 out[2] = -0.5f;
656                 mul_project_m4_v3(rv3d->persinv, out);
657                 sub_v3_v3(out, rv3d->viewinv[3]);
658         }
659         else {
660                 negate_v3_v3(out, rv3d->viewinv[2]);
661         }
662         normalize_v3(out);
663 }
664
665 /**
666  * Calculate a 3d segment from 2d window coordinates.
667  * This ray_start is located at the viewpoint, ray_end is a far point.
668  * ray_start and ray_end are clipped by the view near and far limits
669  * so points along this line are always in view.
670  * In orthographic view all resulting segments will be parallel.
671  * \param ar The region (used for the window width and height).
672  * \param v3d The 3d viewport (used for near and far clipping range).
673  * \param mval The area relative 2d location (such as event->mval, converted into float[2]).
674  * \param r_ray_start The world-space starting point of the segment.
675  * \param r_ray_end The world-space end point of the segment.
676  * \param do_clip_planes Optionally clip the ray by the view clipping planes.
677  * \return success, false if the segment is totally clipped.
678  */
679 bool ED_view3d_win_to_segment_clipped(
680         const ARegion *ar, View3D *v3d, const float mval[2],
681         float r_ray_start[3], float r_ray_end[3], const bool do_clip_planes)
682 {
683         view3d_win_to_ray_segment(ar, v3d, mval, NULL, NULL, r_ray_start, r_ray_end);
684
685         /* bounds clipping */
686         if (do_clip_planes) {
687                 return ED_view3d_clip_segment((RegionView3D *)ar->regiondata, r_ray_start, r_ray_end);
688         }
689
690         return true;
691 }
692
693 /* Utility functions for projection
694  * ******************************** */
695
696 void ED_view3d_ob_project_mat_get(const RegionView3D *rv3d, Object *ob, float pmat[4][4])
697 {
698         float vmat[4][4];
699
700         mul_m4_m4m4(vmat, (float (*)[4])rv3d->viewmat, ob->obmat);
701         mul_m4_m4m4(pmat, (float (*)[4])rv3d->winmat, vmat);
702 }
703
704 void ED_view3d_ob_project_mat_get_from_obmat(const RegionView3D *rv3d, float obmat[4][4], float pmat[4][4])
705 {
706         float vmat[4][4];
707
708         mul_m4_m4m4(vmat, (float (*)[4])rv3d->viewmat, obmat);
709         mul_m4_m4m4(pmat, (float (*)[4])rv3d->winmat, vmat);
710 }
711
712 /**
713  * Uses window coordinates (x,y) and depth component z to find a point in
714  * modelspace */
715 void ED_view3d_unproject(bglMats *mats, float out[3], const float x, const float y, const float z)
716 {
717         double ux, uy, uz;
718
719         gluUnProject(x, y, z, mats->modelview, mats->projection,
720                      (GLint *)mats->viewport, &ux, &uy, &uz);
721
722         out[0] = ux;
723         out[1] = uy;
724         out[2] = uz;
725 }