Cycles / Vector Transform Node:
[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_object_types.h"
32 #include "DNA_screen_types.h"
33 #include "DNA_scene_types.h"
34 #include "DNA_view3d_types.h"
35
36 #include "BLI_sys_types.h"  /* int64_t */
37
38 #include "BIF_gl.h"  /* bglMats */
39 #include "BIF_glutil.h"  /* bglMats */
40
41 #include "BLI_math_vector.h"
42
43 #include "BKE_screen.h"
44
45 #include "ED_view3d.h"  /* own include */
46
47 #define BL_NEAR_CLIP 0.001
48 #define BL_ZERO_CLIP 0.001
49
50 /* Non Clipping Projection Functions
51  * ********************************* */
52
53 /**
54  * \note use #ED_view3d_ob_project_mat_get to get the projection matrix
55  */
56 void ED_view3d_project_float_v2_m4(const ARegion *ar, const float co[3], float r_co[2], float mat[4][4])
57 {
58         float vec4[4];
59         
60         copy_v3_v3(vec4, co);
61         vec4[3] = 1.0;
62         /* r_co[0] = IS_CLIPPED; */ /* always overwritten */
63         
64         mul_m4_v4(mat, vec4);
65         
66         if (vec4[3] > FLT_EPSILON) {
67                 r_co[0] = (float)(ar->winx / 2.0f) + (ar->winx / 2.0f) * vec4[0] / vec4[3];
68                 r_co[1] = (float)(ar->winy / 2.0f) + (ar->winy / 2.0f) * vec4[1] / vec4[3];
69         }
70         else {
71                 zero_v2(r_co);
72         }
73 }
74
75 /**
76  * \note use #ED_view3d_ob_project_mat_get to get projecting mat
77  */
78 void ED_view3d_project_float_v3_m4(const ARegion *ar, const float vec[3], float r_co[3], float mat[4][4])
79 {
80         float vec4[4];
81         
82         copy_v3_v3(vec4, vec);
83         vec4[3] = 1.0;
84         /* r_co[0] = IS_CLIPPED; */ /* always overwritten */
85         
86         mul_m4_v4(mat, vec4);
87         
88         if (vec4[3] > FLT_EPSILON) {
89                 r_co[0] = (float)(ar->winx / 2.0f) + (ar->winx / 2.0f) * vec4[0] / vec4[3];
90                 r_co[1] = (float)(ar->winy / 2.0f) + (ar->winy / 2.0f) * vec4[1] / vec4[3];
91                 r_co[2] = vec4[2] / vec4[3];
92         }
93         else {
94                 zero_v3(r_co);
95         }
96 }
97
98
99 /* Clipping Projection Functions
100  * ***************************** */
101
102 eV3DProjStatus ED_view3d_project_base(const struct ARegion *ar, struct Base *base)
103 {
104         eV3DProjStatus ret = ED_view3d_project_short_global(ar, base->object->obmat[3], &base->sx, V3D_PROJ_TEST_CLIP_DEFAULT);
105
106         if (ret != V3D_PROJ_RET_OK) {
107                 base->sx = IS_CLIPPED;
108                 base->sy = 0;
109         }
110
111         return ret;
112 }
113
114 /* perspmat is typically...
115  * - 'rv3d->perspmat',   is_local == false
116  * - 'rv3d->persmatob', is_local == true
117  */
118 static eV3DProjStatus ed_view3d_project__internal(const ARegion *ar,
119                                                   float perspmat[4][4], const bool is_local,  /* normally hidden */
120                                                   const float co[3], float r_co[2], const eV3DProjTest flag)
121 {
122         float vec4[4];
123
124         /* check for bad flags */
125         BLI_assert((flag & V3D_PROJ_TEST_ALL) == flag);
126
127         if (flag & V3D_PROJ_TEST_CLIP_BB) {
128                 RegionView3D *rv3d = ar->regiondata;
129                 if (rv3d->rflag & RV3D_CLIPPING) {
130                         if (ED_view3d_clipping_test(rv3d, co, is_local)) {
131                                 return V3D_PROJ_RET_CLIP_BB;
132                         }
133                 }
134         }
135
136         copy_v3_v3(vec4, co);
137         vec4[3] = 1.0;
138         mul_m4_v4(perspmat, vec4);
139
140
141
142         if (((flag & V3D_PROJ_TEST_CLIP_ZERO) == 0) || (fabsf(vec4[3]) > (float)BL_ZERO_CLIP)) {
143                 if (((flag & V3D_PROJ_TEST_CLIP_NEAR) == 0)  || (vec4[3] > (float)BL_NEAR_CLIP)) {
144                         const float scalar = (vec4[3] != 0.0f) ? (1.0f / vec4[3]): 0.0f;
145                         const float fx = ((float)ar->winx / 2.0f) * (1.0f + (vec4[0] * scalar));
146                         if (((flag & V3D_PROJ_TEST_CLIP_WIN) == 0) || (fx > 0.0f && fx < (float)ar->winx)) {
147                                 const float fy = ((float)ar->winy / 2.0f) * (1.0f + (vec4[1] * scalar));
148                                 if (((flag & V3D_PROJ_TEST_CLIP_WIN) == 0) || (fy > 0.0f && fy < (float)ar->winy)) {
149                                         r_co[0] = fx;
150                                         r_co[1] = fy;
151
152                                         /* check if the point is behind the view, we need to flip in this case */
153                                         if (UNLIKELY((flag & V3D_PROJ_TEST_CLIP_NEAR) == 0) && (vec4[3] < 0.0f)) {
154                                                 negate_v2(r_co);
155                                         }
156                                 }
157                                 else {
158                                         return V3D_PROJ_RET_CLIP_WIN;
159                                 }
160                         }
161                         else {
162                                 return V3D_PROJ_RET_CLIP_WIN;
163                         }
164                 }
165                 else {
166                         return V3D_PROJ_RET_CLIP_NEAR;
167                 }
168         }
169         else {
170                 return V3D_PROJ_RET_CLIP_ZERO;
171         }
172
173         return V3D_PROJ_RET_OK;
174 }
175
176 eV3DProjStatus ED_view3d_project_short_ex(const ARegion *ar, float perspmat[4][4], const bool is_local,
177                                           const float co[3], short r_co[2], const eV3DProjTest flag)
178 {
179         float tvec[2];
180         eV3DProjStatus ret = ed_view3d_project__internal(ar, perspmat, is_local, co, tvec, flag);
181         if (ret == V3D_PROJ_RET_OK) {
182                 if ((tvec[0] > -32700.0f && tvec[0] < 32700.0f) &&
183                     (tvec[1] > -32700.0f && tvec[1] < 32700.0f))
184                 {
185                         r_co[0] = (short)floorf(tvec[0]);
186                         r_co[1] = (short)floorf(tvec[1]);
187                 }
188                 else {
189                         ret = V3D_PROJ_RET_OVERFLOW;
190                 }
191         }
192         return ret;
193 }
194
195 eV3DProjStatus ED_view3d_project_int_ex(const ARegion *ar, float perspmat[4][4], const bool is_local,
196                                         const float co[3], int r_co[2], const eV3DProjTest flag)
197 {
198         float tvec[2];
199         eV3DProjStatus ret = ed_view3d_project__internal(ar, perspmat, is_local, co, tvec, flag);
200         if (ret == V3D_PROJ_RET_OK) {
201                 if ((tvec[0] > -2140000000.0f && tvec[0] < 2140000000.0f) &&
202                     (tvec[1] > -2140000000.0f && tvec[1] < 2140000000.0f))
203                 {
204                         r_co[0] = (int)floorf(tvec[0]);
205                         r_co[1] = (int)floorf(tvec[1]);
206                 }
207                 else {
208                         ret = V3D_PROJ_RET_OVERFLOW;
209                 }
210         }
211         return ret;
212 }
213
214 eV3DProjStatus ED_view3d_project_float_ex(const ARegion *ar, float perspmat[4][4], const bool is_local,
215                                         const float co[3], float r_co[2], const eV3DProjTest flag)
216 {
217         float tvec[2];
218         eV3DProjStatus ret = ed_view3d_project__internal(ar, perspmat, is_local, co, tvec, flag);
219         if (ret == V3D_PROJ_RET_OK) {
220                 if (finite(tvec[0]) &&
221                     finite(tvec[1]))
222                 {
223                         copy_v2_v2(r_co, tvec);
224                 }
225                 else {
226                         ret = V3D_PROJ_RET_OVERFLOW;
227                 }
228         }
229         return ret;
230 }
231
232 /* --- short --- */
233 eV3DProjStatus ED_view3d_project_short_global(const ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag)
234 {
235         RegionView3D *rv3d = ar->regiondata;
236         return ED_view3d_project_short_ex(ar, rv3d->persmat, false, co, r_co, flag);
237 }
238 /* object space, use ED_view3d_init_mats_rv3d before calling */
239 eV3DProjStatus ED_view3d_project_short_object(const ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag)
240 {
241         RegionView3D *rv3d = ar->regiondata;
242         ED_view3d_check_mats_rv3d(rv3d);
243         return ED_view3d_project_short_ex(ar, rv3d->persmatob, true, co, r_co, flag);
244 }
245
246 /* --- int --- */
247 eV3DProjStatus ED_view3d_project_int_global(const ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag)
248 {
249         RegionView3D *rv3d = ar->regiondata;
250         return ED_view3d_project_int_ex(ar, rv3d->persmat, false, co, r_co, flag);
251 }
252 /* object space, use ED_view3d_init_mats_rv3d before calling */
253 eV3DProjStatus ED_view3d_project_int_object(const ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag)
254 {
255         RegionView3D *rv3d = ar->regiondata;
256         ED_view3d_check_mats_rv3d(rv3d);
257         return ED_view3d_project_int_ex(ar, rv3d->persmatob, true, co, r_co, flag);
258 }
259
260 /* --- float --- */
261 eV3DProjStatus ED_view3d_project_float_global(const ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag)
262 {
263         RegionView3D *rv3d = ar->regiondata;
264         return ED_view3d_project_float_ex(ar, rv3d->persmat, false, co, r_co, flag);
265 }
266 /* object space, use ED_view3d_init_mats_rv3d before calling */
267 eV3DProjStatus ED_view3d_project_float_object(const ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag)
268 {
269         RegionView3D *rv3d = ar->regiondata;
270         ED_view3d_check_mats_rv3d(rv3d);
271         return ED_view3d_project_float_ex(ar, rv3d->persmatob, true, co, r_co, flag);
272 }
273
274
275
276 /* More Generic Window/Ray/Vector projection functions
277  * *************************************************** */
278
279 /**
280  * Caculate a depth value from \a co, use with #ED_view3d_win_to_delta
281  */
282 float ED_view3d_calc_zfac(const RegionView3D *rv3d, const float co[3], bool *r_flip)
283 {
284         float zfac = mul_project_m4_v3_zfac((float (*)[4])rv3d->persmat, co);
285
286         if (r_flip) {
287                 *r_flip = (zfac < 0.0f);
288         }
289
290         /* if x,y,z is exactly the viewport offset, zfac is 0 and we don't want that
291          * (accounting for near zero values) */
292         if (zfac < 1.e-6f && zfac > -1.e-6f) {
293                 zfac = 1.0f;
294         }
295
296         /* Negative zfac means x, y, z was behind the camera (in perspective).
297          * This gives flipped directions, so revert back to ok default case. */
298         if (zfac < 0.0f) {
299                 zfac = -zfac;
300         }
301
302         return zfac;
303 }
304
305 /**
306  * Calculate a 3d viewpoint and direction vector from 2d window coordinates.
307  * This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
308  * ray_start is clipped by the view near limit so points in front of it are always in view.
309  * In orthographic view the resulting ray_normal will match the view vector.
310  * \param ar The region (used for the window width and height).
311  * \param v3d The 3d viewport (used for near clipping value).
312  * \param mval The area relative 2d location (such as event->mval, converted into float[2]).
313  * \param ray_start The world-space starting point of the segment.
314  * \param ray_normal The normalized world-space direction of towards mval.
315  * \return success, false if the segment is totally clipped.
316  */
317 bool ED_view3d_win_to_ray(const ARegion *ar, View3D *v3d, const float mval[2],
318                           float r_ray_start[3], float r_ray_normal[3], const bool do_clip)
319 {
320         float ray_end[3];
321         bool is_clip;
322         
323         is_clip = ED_view3d_win_to_segment(ar, v3d, mval, r_ray_start, ray_end, do_clip);
324         sub_v3_v3v3(r_ray_normal, ray_end, r_ray_start);
325         normalize_v3(r_ray_normal);
326         return is_clip;
327 }
328
329 /**
330  * Calculate a normalized 3d direction vector from the viewpoint towards a global location.
331  * In orthographic view the resulting vector will match the view vector.
332  * \param rv3d The region (used for the window width and height).
333  * \param coord The world-space location.
334  * \param vec The resulting normalized vector.
335  */
336 void ED_view3d_global_to_vector(const RegionView3D *rv3d, const float coord[3], float vec[3])
337 {
338         if (rv3d->is_persp) {
339                 float p1[4], p2[4];
340
341                 copy_v3_v3(p1, coord);
342                 p1[3] = 1.0f;
343                 copy_v3_v3(p2, p1);
344                 p2[3] = 1.0f;
345                 mul_m4_v4((float (*)[4])rv3d->viewmat, p2);
346
347                 mul_v3_fl(p2, 2.0f);
348
349                 mul_m4_v4((float (*)[4])rv3d->viewinv, p2);
350
351                 sub_v3_v3v3(vec, p1, p2);
352         }
353         else {
354                 copy_v3_v3(vec, rv3d->viewinv[2]);
355         }
356         normalize_v3(vec);
357 }
358
359 /* very similar to ED_view3d_win_to_3d() but has no advantage, de-duplicating */
360 #if 0
361 bool view3d_get_view_aligned_coordinate(ARegion *ar, float fp[3], const int mval[2], const bool do_fallback)
362 {
363         RegionView3D *rv3d = ar->regiondata;
364         float dvec[3];
365         int mval_cpy[2];
366         eV3DProjStatus ret;
367
368         ret = ED_view3d_project_int_global(ar, fp, mval_cpy, V3D_PROJ_TEST_NOP);
369
370         if (ret == V3D_PROJ_RET_OK) {
371                 const float mval_f[2] = {(float)(mval_cpy[0] - mval[0]),
372                                          (float)(mval_cpy[1] - mval[1])};
373                 const float zfac = ED_view3d_calc_zfac(rv3d, fp, NULL);
374                 ED_view3d_win_to_delta(ar, mval_f, dvec, zfac);
375                 sub_v3_v3(fp, dvec);
376
377                 return true;
378         }
379         else {
380                 /* fallback to the view center */
381                 if (do_fallback) {
382                         negate_v3_v3(fp, rv3d->ofs);
383                         return view3d_get_view_aligned_coordinate(ar, fp, mval, false);
384                 }
385                 else {
386                         return false;
387                 }
388         }
389 }
390 #endif
391
392 /**
393  * Calculate a 3d location from 2d window coordinates.
394  * \param ar The region (used for the window width and height).
395  * \param depth_pt The reference location used to calculate the Z depth.
396  * \param mval The area relative location (such as event->mval converted to floats).
397  * \param out The resulting world-space location.
398  */
399 void ED_view3d_win_to_3d(const ARegion *ar, const float depth_pt[3], const float mval[2], float out[3])
400 {
401         RegionView3D *rv3d = ar->regiondata;
402
403         float line_sta[3];
404         float line_end[3];
405
406         if (rv3d->is_persp) {
407                 float mousevec[3];
408                 copy_v3_v3(line_sta, rv3d->viewinv[3]);
409                 ED_view3d_win_to_vector(ar, mval, mousevec);
410                 add_v3_v3v3(line_end, line_sta, mousevec);
411
412                 if (isect_line_plane_v3(out, line_sta, line_end, depth_pt, rv3d->viewinv[2], true) == 0) {
413                         /* highly unlikely to ever happen, mouse vector parallel with view plane */
414                         zero_v3(out);
415                 }
416         }
417         else {
418                 float dx = (2.0f * mval[0] / (float)ar->winx) - 1.0f;
419                 float dy = (2.0f * mval[1] / (float)ar->winy) - 1.0f;
420                 if (rv3d->persp == RV3D_CAMOB) {
421                         /* ortho camera needs offset applied */
422                         const float zoomfac = BKE_screen_view3d_zoom_to_fac((float)rv3d->camzoom) * 4.0f;
423                         dx += rv3d->camdx * zoomfac;
424                         dy += rv3d->camdy * zoomfac;
425                 }
426                 line_sta[0] = (rv3d->persinv[0][0] * dx) + (rv3d->persinv[1][0] * dy) + rv3d->viewinv[3][0];
427                 line_sta[1] = (rv3d->persinv[0][1] * dx) + (rv3d->persinv[1][1] * dy) + rv3d->viewinv[3][1];
428                 line_sta[2] = (rv3d->persinv[0][2] * dx) + (rv3d->persinv[1][2] * dy) + rv3d->viewinv[3][2];
429
430                 add_v3_v3v3(line_end, line_sta, rv3d->viewinv[2]);
431                 closest_to_line_v3(out, depth_pt, line_sta, line_end);
432         }
433 }
434
435 void ED_view3d_win_to_3d_int(const ARegion *ar, const float depth_pt[3], const int mval[2], float out[3])
436 {
437         const float mval_fl[2] = {mval[0], mval[1]};
438         ED_view3d_win_to_3d(ar, depth_pt, mval_fl, out);
439 }
440
441 /**
442  * Calculate a 3d difference vector from 2d window offset.
443  * note that ED_view3d_calc_zfac() must be called first to determine
444  * the depth used to calculate the delta.
445  * \param ar The region (used for the window width and height).
446  * \param mval The area relative 2d difference (such as event->mval[0] - other_x).
447  * \param out The resulting world-space delta.
448  */
449 void ED_view3d_win_to_delta(const ARegion *ar, const float mval[2], float out[3], const float zfac)
450 {
451         RegionView3D *rv3d = ar->regiondata;
452         float dx, dy;
453         
454         dx = 2.0f * mval[0] * zfac / ar->winx;
455         dy = 2.0f * mval[1] * zfac / ar->winy;
456         
457         out[0] = (rv3d->persinv[0][0] * dx + rv3d->persinv[1][0] * dy);
458         out[1] = (rv3d->persinv[0][1] * dx + rv3d->persinv[1][1] * dy);
459         out[2] = (rv3d->persinv[0][2] * dx + rv3d->persinv[1][2] * dy);
460 }
461
462 /**
463  * Calculate a 3d direction vector from 2d window coordinates.
464  * This direction vector starts and the view in the direction of the 2d window coordinates.
465  * In orthographic view all window coordinates yield the same vector.
466  *
467  * \note doesn't rely on ED_view3d_calc_zfac
468  * for perspective view, get the vector direction to
469  * the mouse cursor as a normalized vector.
470  *
471  * \param ar The region (used for the window width and height).
472  * \param mval The area relative 2d location (such as event->mval converted to floats).
473  * \param out The resulting normalized world-space direction vector.
474  */
475 void ED_view3d_win_to_vector(const ARegion *ar, const float mval[2], float out[3])
476 {
477         RegionView3D *rv3d = ar->regiondata;
478
479         if (rv3d->is_persp) {
480                 out[0] = 2.0f * (mval[0] / ar->winx) - 1.0f;
481                 out[1] = 2.0f * (mval[1] / ar->winy) - 1.0f;
482                 out[2] = -0.5f;
483                 mul_project_m4_v3(rv3d->persinv, out);
484                 sub_v3_v3(out, rv3d->viewinv[3]);
485         }
486         else {
487                 copy_v3_v3(out, rv3d->viewinv[2]);
488         }
489         normalize_v3(out);
490 }
491
492 /**
493  * Calculate a 3d segment from 2d window coordinates.
494  * This ray_start is located at the viewpoint, ray_end is a far point.
495  * ray_start and ray_end are clipped by the view near and far limits
496  * so points along this line are always in view.
497  * In orthographic view all resulting segments will be parallel.
498  * \param ar The region (used for the window width and height).
499  * \param v3d The 3d viewport (used for near and far clipping range).
500  * \param mval The area relative 2d location (such as event->mval, converted into float[2]).
501  * \param r_ray_start The world-space starting point of the segment.
502  * \param r_ray_end The world-space end point of the segment.
503  * \param do_clip Optionally clip the ray by the view clipping planes.
504  * \return success, false if the segment is totally clipped.
505  */
506 bool ED_view3d_win_to_segment(const ARegion *ar, View3D *v3d, const float mval[2],
507                               float ray_start[3], float ray_end[3], const bool do_clip)
508 {
509         RegionView3D *rv3d = ar->regiondata;
510
511         if (rv3d->is_persp) {
512                 float vec[3];
513                 ED_view3d_win_to_vector(ar, mval, vec);
514
515                 copy_v3_v3(ray_start, rv3d->viewinv[3]);
516                 madd_v3_v3v3fl(ray_start, rv3d->viewinv[3], vec, v3d->near);
517                 madd_v3_v3v3fl(ray_end, rv3d->viewinv[3], vec, v3d->far);
518         }
519         else {
520                 float vec[4];
521                 vec[0] = 2.0f * mval[0] / ar->winx - 1;
522                 vec[1] = 2.0f * mval[1] / ar->winy - 1;
523                 vec[2] = 0.0f;
524                 vec[3] = 1.0f;
525
526                 mul_m4_v4(rv3d->persinv, vec);
527
528                 madd_v3_v3v3fl(ray_start, vec, rv3d->viewinv[2],  1000.0f);
529                 madd_v3_v3v3fl(ray_end, vec, rv3d->viewinv[2], -1000.0f);
530         }
531
532         /* bounds clipping */
533         if (do_clip && (rv3d->rflag & RV3D_CLIPPING)) {
534                 if (clip_segment_v3_plane_n(ray_start, ray_end, rv3d->clip, 6) == false) {
535                         return false;
536                 }
537         }
538
539         return true;
540 }
541
542 /* Utility functions for projection
543  * ******************************** */
544
545 void ED_view3d_ob_project_mat_get(const RegionView3D *rv3d, Object *ob, float pmat[4][4])
546 {
547         float vmat[4][4];
548
549         mul_m4_m4m4(vmat, (float (*)[4])rv3d->viewmat, ob->obmat);
550         mul_m4_m4m4(pmat, (float (*)[4])rv3d->winmat, vmat);
551 }
552
553 /**
554  * Uses window coordinates (x,y) and depth component z to find a point in
555  * modelspace */
556 void ED_view3d_unproject(bglMats *mats, float out[3], const float x, const float y, const float z)
557 {
558         double ux, uy, uz;
559
560         gluUnProject(x, y, z, mats->modelview, mats->projection,
561                      (GLint *)mats->viewport, &ux, &uy, &uz);
562
563         out[0] = ux;
564         out[1] = uy;
565         out[2] = uz;
566 }