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