Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / include / ED_view3d.h
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 ED_view3d.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_VIEW3D_H__
32 #define __ED_VIEW3D_H__
33
34 /* ********* exports for space_view3d/ module ********** */
35 struct ARegion;
36 struct BMEdge;
37 struct BMFace;
38 struct BMVert;
39 struct BPoint;
40 struct BaseLegacy;
41 struct BezTriple;
42 struct BoundBox;
43 struct EditBone;
44 struct ImBuf;
45 struct MVert;
46 struct Main;
47 struct MetaElem;
48 struct Nurb;
49 struct Object;
50 struct RV3DMatrixStore;
51 struct RegionView3D;
52 struct Scene;
53 struct SceneLayer;
54 struct ScrArea;
55 struct View3D;
56 struct ViewContext;
57 struct bContext;
58 struct bPoseChannel;
59 struct bScreen;
60 struct rctf;
61 struct rcti;
62 struct wmOperator;
63 struct wmOperatorType;
64 struct wmWindow;
65 struct wmWindowManager;
66 struct GPUFX;
67 struct GPUOffScreen;
68 struct GPUFXSettings;
69 enum eGPUFXFlags;
70
71 /* for derivedmesh drawing callbacks, for view3d_select, .... */
72 typedef struct ViewContext {
73         struct Scene *scene;
74         struct SceneLayer *sl;
75         struct Object *obact;
76         struct Object *obedit;
77         struct ARegion *ar;
78         struct View3D *v3d;
79         struct wmWindow *win;
80         struct RegionView3D *rv3d;
81         struct BMEditMesh *em;
82         int mval[2];
83 } ViewContext;
84
85 typedef struct ViewDepths {
86         unsigned short w, h;
87         short x, y; /* only for temp use for sub-rects, added to ar->winx/y */
88         float *depths;
89         double depth_range[2];
90         
91         bool damaged;
92 } ViewDepths;
93
94 float *ED_view3d_cursor3d_get(struct Scene *scene, struct View3D *v3d);
95 void   ED_view3d_cursor3d_position(struct bContext *C, float fp[3], const int mval[2]);
96 void   ED_view3d_cursor3d_update(struct bContext *C, const int mval[2]);
97
98 struct Camera *ED_view3d_camera_data_get(struct View3D *v3d, struct RegionView3D *rv3d);
99
100 void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], const float dist);
101 void ED_view3d_from_m4(float mat[4][4], float ofs[3], float quat[4], float *dist);
102
103 void ED_view3d_from_object(struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens);
104 void ED_view3d_to_object(struct Object *ob, const float ofs[3], const float quat[4], const float dist);
105
106 void ED_view3d_lastview_store(struct RegionView3D *rv3d);
107
108 /* Depth buffer */
109 void  ED_view3d_depth_update(struct ARegion *ar);
110 float ED_view3d_depth_read_cached(const struct ViewContext *vc, int x, int y);
111 void  ED_view3d_depth_tag_update(struct RegionView3D *rv3d);
112
113 /* Projection */
114 #define IS_CLIPPED        12000
115
116 /* return values for ED_view3d_project_...() */
117 typedef enum {
118         V3D_PROJ_RET_OK   = 0,
119         V3D_PROJ_RET_CLIP_NEAR = 1,  /* can't avoid this when in perspective mode, (can't avoid) */
120         V3D_PROJ_RET_CLIP_ZERO = 2,  /* so close to zero we can't apply a perspective matrix usefully */
121         V3D_PROJ_RET_CLIP_BB   = 3,  /* bounding box clip - RV3D_CLIPPING */
122         V3D_PROJ_RET_CLIP_WIN  = 4,  /* outside window bounds */
123         V3D_PROJ_RET_OVERFLOW  = 5   /* outside range (mainly for short), (can't avoid) */
124 } eV3DProjStatus;
125
126 /* some clipping tests are optional */
127 typedef enum {
128         V3D_PROJ_TEST_NOP        = 0,
129         V3D_PROJ_TEST_CLIP_BB    = (1 << 0),
130         V3D_PROJ_TEST_CLIP_WIN   = (1 << 1),
131         V3D_PROJ_TEST_CLIP_NEAR  = (1 << 2),
132         V3D_PROJ_TEST_CLIP_ZERO  = (1 << 3)
133 } eV3DProjTest;
134
135 #define V3D_PROJ_TEST_CLIP_DEFAULT \
136         (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN | V3D_PROJ_TEST_CLIP_NEAR)
137 #define V3D_PROJ_TEST_ALL \
138         (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN | V3D_PROJ_TEST_CLIP_NEAR | V3D_PROJ_TEST_CLIP_ZERO)
139
140
141 /* view3d_iterators.c */
142
143 /* foreach iterators */
144 void meshobject_foreachScreenVert(
145         struct ViewContext *vc,
146         void (*func)(void *userData, struct MVert *eve, const float screen_co[2], int index),
147         void *userData, const eV3DProjTest clip_flag);
148 void mesh_foreachScreenVert(
149         struct ViewContext *vc,
150         void (*func)(void *userData, struct BMVert *eve, const float screen_co[2], int index),
151         void *userData, const eV3DProjTest clip_flag);
152 void mesh_foreachScreenEdge(
153         struct ViewContext *vc,
154         void (*func)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2],
155                      int index),
156         void *userData, const eV3DProjTest clip_flag);
157 void mesh_foreachScreenFace(
158         struct ViewContext *vc,
159         void (*func)(void *userData, struct BMFace *efa, const float screen_co[2], int index),
160         void *userData, const eV3DProjTest clip_flag);
161 void nurbs_foreachScreenVert(
162         struct ViewContext *vc,
163         void (*func)(void *userData, struct Nurb *nu, struct BPoint *bp, struct BezTriple *bezt,
164                      int beztindex, const float screen_co[2]),
165         void *userData, const eV3DProjTest clip_flag);
166 void mball_foreachScreenElem(
167         struct ViewContext *vc,
168         void (*func)(void *userData, struct MetaElem *ml, const float screen_co[2]),
169         void *userData, const eV3DProjTest clip_flag);
170 void lattice_foreachScreenVert(
171         struct ViewContext *vc,
172         void (*func)(void *userData, struct BPoint *bp,
173                      const float screen_co[2]),
174         void *userData, const eV3DProjTest clip_flag);
175 void armature_foreachScreenBone(
176         struct ViewContext *vc,
177         void (*func)(void *userData, struct EditBone *ebone,
178                      const float screen_co_a[2], const float screen_co_b[2]),
179         void *userData, const eV3DProjTest clip_flag);
180 void pose_foreachScreenBone(
181         struct ViewContext *vc,
182         void (*func)(void *userData, struct bPoseChannel *pchan,
183                      const float screen_co_a[2], const float screen_co_b[2]),
184         void *userData, const eV3DProjTest clip_flag);
185 /* *** end iterators *** */
186
187
188 /* view3d_project.c */
189 void ED_view3d_project_float_v2_m4(const struct ARegion *ar, const float co[3], float r_co[2], float mat[4][4]);
190 void ED_view3d_project_float_v3_m4(const struct ARegion *ar, const float co[3], float r_co[3], float mat[4][4]);
191
192 eV3DProjStatus ED_view3d_project_base(const struct ARegion *ar, struct BaseLegacy *base);
193
194 /* *** short *** */
195 eV3DProjStatus ED_view3d_project_short_ex(const struct ARegion *ar, float perspmat[4][4], const bool is_local,
196                                           const float co[3], short r_co[2], const eV3DProjTest flag);
197 eV3DProjStatus ED_view3d_project_short_global(const struct ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag);
198 eV3DProjStatus ED_view3d_project_short_object(const struct ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag);
199
200 /* *** int *** */
201 eV3DProjStatus ED_view3d_project_int_ex(const struct ARegion *ar, float perspmat[4][4], const bool is_local,
202                                         const float co[3], int r_co[2], const eV3DProjTest flag);
203 eV3DProjStatus ED_view3d_project_int_global(const struct ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag);
204 eV3DProjStatus ED_view3d_project_int_object(const struct ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag);
205
206 /* *** float *** */
207 eV3DProjStatus ED_view3d_project_float_ex(const struct ARegion *ar, float perspmat[4][4], const bool is_local,
208                                           const float co[3], float r_co[2], const eV3DProjTest flag);
209 eV3DProjStatus ED_view3d_project_float_global(const struct ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag);
210 eV3DProjStatus ED_view3d_project_float_object(const struct ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag);
211
212 float ED_view3d_calc_zfac(const struct RegionView3D *rv3d, const float co[3], bool *r_flip);
213 bool ED_view3d_clip_segment(const struct RegionView3D *rv3d, float ray_start[3], float ray_end[3]);
214 bool ED_view3d_win_to_ray(
215         const struct ARegion *ar, const struct View3D *v3d, const float mval[2],
216         float ray_start[3], float ray_normal[3], const bool do_clip);
217 bool ED_view3d_win_to_ray_ex(
218         const struct ARegion *ar, const struct View3D *v3d, const float mval[2],
219         float r_ray_co[3], float r_ray_normal[3], float r_ray_start[3], bool do_clip);
220 void ED_view3d_global_to_vector(const struct RegionView3D *rv3d, const float coord[3], float vec[3]);
221 void ED_view3d_win_to_3d(
222         const struct View3D *v3d, const struct ARegion *ar,
223         const float depth_pt[3], const float mval[2],
224         float r_out[3]);
225 void ED_view3d_win_to_3d_int(
226         const struct View3D *v3d, const struct ARegion *ar,
227         const float depth_pt[3], const int mval[2],
228         float r_out[3]);
229 void ED_view3d_win_to_delta(const struct ARegion *ar, const float mval[2], float out[3], const float zfac);
230 void ED_view3d_win_to_origin(const struct ARegion *ar, const float mval[2], float out[3]);
231 void ED_view3d_win_to_vector(const struct ARegion *ar, const float mval[2], float out[3]);
232 bool ED_view3d_win_to_segment(const struct ARegion *ar, struct View3D *v3d, const float mval[2],
233                               float r_ray_start[3], float r_ray_end[3], const bool do_clip);
234 void ED_view3d_ob_project_mat_get(const struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
235 void ED_view3d_ob_project_mat_get_from_obmat(const struct RegionView3D *rv3d, float obmat[4][4], float pmat[4][4]);
236
237 void ED_view3d_project(const struct ARegion *ar, const float world[3], float region[3]);
238 bool ED_view3d_unproject(const struct ARegion *ar, float regionx, float regiony, float regionz, float world[3]);
239
240 /* end */
241
242
243 void ED_view3d_dist_range_get(
244         const struct View3D *v3d,
245         float r_dist_range[2]);
246 bool ED_view3d_clip_range_get(
247         const struct View3D *v3d, const struct RegionView3D *rv3d,
248         float *r_clipsta, float *r_clipend, const bool use_ortho_factor);
249 bool ED_view3d_viewplane_get(
250         const struct View3D *v3d, const struct RegionView3D *rv3d, int winxi, int winyi,
251         struct rctf *r_viewplane, float *r_clipsta, float *r_clipend, float *r_pixsize);
252
253 void ED_view3d_polygon_offset(const struct RegionView3D *rv3d, const float dist);
254
255 void ED_view3d_calc_camera_border(
256         const struct Scene *scene, const struct ARegion *ar,
257         const struct View3D *v3d, const struct RegionView3D *rv3d,
258         struct rctf *r_viewborder, const bool no_shift);
259 void ED_view3d_calc_camera_border_size(
260         const struct Scene *scene, const struct ARegion *ar,
261         const struct View3D *v3d, const struct RegionView3D *rv3d,
262         float r_size[2]);
263 bool ED_view3d_calc_render_border(struct Scene *scene, struct View3D *v3d,
264                                   struct ARegion *ar, struct rcti *rect);
265
266 void ED_view3d_clipping_calc_from_boundbox(float clip[6][4], const struct BoundBox *clipbb, const bool is_flip);
267 void ED_view3d_clipping_calc(struct BoundBox *bb, float planes[4][4],
268         const struct ARegion *ar, const struct Object *ob, const struct rcti *rect);
269 void ED_view3d_clipping_local(struct RegionView3D *rv3d, float mat[4][4]);
270 bool ED_view3d_clipping_test(const struct RegionView3D *rv3d, const float co[3], const bool is_local);
271 void ED_view3d_clipping_set(struct RegionView3D *rv3d);
272 void ED_view3d_clipping_enable(void);
273 void ED_view3d_clipping_disable(void);
274
275 float ED_view3d_pixel_size(const struct RegionView3D *rv3d, const float co[3]);
276
277 float ED_view3d_radius_to_dist_persp(const float angle, const float radius);
278 float ED_view3d_radius_to_dist_ortho(const float lens, const float radius);
279 float ED_view3d_radius_to_dist(
280         const struct View3D *v3d, const struct ARegion *ar,
281         const char persp, const bool use_aspect,
282         const float radius);
283
284 void drawcircball(int mode, const float cent[3], float rad, const float tmat[4][4]);
285 void imm_drawcircball(const float cent[3], float rad, const float tmat[4][4], unsigned pos);
286
287 /* backbuffer select and draw support */
288 void          ED_view3d_backbuf_validate(struct ViewContext *vc);
289 struct ImBuf *ED_view3d_backbuf_read(struct ViewContext *vc, int xmin, int ymin, int xmax, int ymax);
290 unsigned int  ED_view3d_backbuf_sample_rect(
291         struct ViewContext *vc, const int mval[2], int size,
292         unsigned int min, unsigned int max, float *r_dist);
293 int          ED_view3d_backbuf_sample_size_clamp(struct ARegion *ar, const float dist);
294 unsigned int ED_view3d_backbuf_sample(struct ViewContext *vc, int x, int y);
295
296 bool ED_view3d_autodist(
297         struct Scene *scene, struct ARegion *ar, struct View3D *v3d,
298         const int mval[2], float mouse_worldloc[3],
299         const bool alphaoverride, const float fallback_depth_pt[3]);
300
301 /* only draw so ED_view3d_autodist_simple can be called many times after */
302 void ED_view3d_autodist_init(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, int mode);
303 bool ED_view3d_autodist_simple(struct ARegion *ar, const int mval[2], float mouse_worldloc[3], int margin, float *force_depth);
304 bool ED_view3d_autodist_depth(struct ARegion *ar, const int mval[2], int margin, float *depth);
305 bool ED_view3d_autodist_depth_seg(struct ARegion *ar, const int mval_sta[2], const int mval_end[2], int margin, float *depth);
306
307 /* select */
308 #define MAXPICKELEMS    2500
309 #define MAXPICKBUF      (4 * MAXPICKELEMS)
310 short view3d_opengl_select(struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, const struct rcti *input, bool do_nearest);
311
312 /* view3d_select.c */
313 float ED_view3d_select_dist_px(void);
314 void view3d_set_viewcontext(struct bContext *C, struct ViewContext *vc);
315 void view3d_operator_needs_opengl(const struct bContext *C);
316 void view3d_region_operator_needs_opengl(struct wmWindow *win, struct ARegion *ar);
317 void view3d_opengl_read_pixels(struct ARegion *ar, int x, int y, int w, int h, int format, int type, void *data);
318
319 /* XXX should move to BLI_math */
320 bool edge_inside_circle(const float cent[2], float radius, const float screen_co_a[2], const float screen_co_b[2]);
321
322 /* get 3d region from context, also if mouse is in header or toolbar */
323 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
324 bool ED_view3d_context_user_region(struct bContext *C, struct View3D **r_v3d, struct ARegion **r_ar);
325 int ED_operator_rv3d_user_region_poll(struct bContext *C);
326
327 void ED_view3d_init_mats_rv3d(struct Object *ob, struct RegionView3D *rv3d);
328 void ED_view3d_init_mats_rv3d_gl(struct Object *ob, struct RegionView3D *rv3d);
329 #ifdef DEBUG
330 void ED_view3d_clear_mats_rv3d(struct RegionView3D *rv3d);
331 void ED_view3d_check_mats_rv3d(struct RegionView3D *rv3d);
332 #else
333 #  define ED_view3d_clear_mats_rv3d(rv3d) (void)(rv3d)
334 #  define ED_view3d_check_mats_rv3d(rv3d) (void)(rv3d)
335 #endif
336 int ED_view3d_scene_layer_set(int lay, const int *values, int *active);
337
338 struct RV3DMatrixStore *ED_view3d_mats_rv3d_backup(struct RegionView3D *rv3d);
339 void                    ED_view3d_mats_rv3d_restore(struct RegionView3D *rv3d, struct RV3DMatrixStore *rv3dmat);
340
341 bool ED_view3d_context_activate(struct bContext *C);
342 void ED_view3d_draw_offscreen_init(struct Scene *scene, struct SceneLayer *sl, struct View3D *v3d);
343 void ED_view3d_draw_offscreen(
344         struct Scene *scene, struct View3D *v3d, struct ARegion *ar, int winx, int winy, float viewmat[4][4],
345         float winmat[4][4], bool do_bgpic, bool do_sky, bool is_persp, const char *viewname,
346         struct GPUFX *fx, struct GPUFXSettings *fx_settings,
347         struct GPUOffScreen *ofs);
348
349 struct ImBuf *ED_view3d_draw_offscreen_imbuf(
350         struct Scene *scene, struct SceneLayer *sl, struct View3D *v3d, struct ARegion *ar, int sizex, int sizey,
351         unsigned int flag, bool draw_background,
352         int alpha_mode, int samples, bool full_samples, const char *viewname,
353         struct GPUFX *fx, struct GPUOffScreen *ofs, char err_out[256]);
354 struct ImBuf *ED_view3d_draw_offscreen_imbuf_simple(
355         struct Scene *scene, struct SceneLayer *sl, struct Object *camera, int width, int height,
356         unsigned int flag, int drawtype, bool use_solid_tex, bool use_gpencil, bool draw_background,
357         int alpha_mode, int samples, bool full_samples, const char *viewname,
358         struct GPUFX *fx, struct GPUOffScreen *ofs, char err_out[256]);
359
360 struct BaseLegacy *ED_view3d_give_base_under_cursor(struct bContext *C, const int mval[2]);
361 void ED_view3d_quadview_update(struct ScrArea *sa, struct ARegion *ar, bool do_clip);
362 void ED_view3d_update_viewmat(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, float viewmat[4][4], float winmat[4][4]);
363 bool ED_view3d_quat_from_axis_view(const char view, float quat[4]);
364 char ED_view3d_quat_to_axis_view(const float quat[4], const float epsilon);
365 char ED_view3d_lock_view_from_index(int index);
366 char ED_view3d_axis_view_opposite(char view);
367 bool ED_view3d_lock(struct RegionView3D *rv3d);
368
369 uint64_t ED_view3d_datamask(const struct Scene *scene, const struct View3D *v3d);
370 uint64_t ED_view3d_screen_datamask(const struct bScreen *screen);
371
372 bool ED_view3d_offset_lock_check(const struct View3D *v3d, const struct RegionView3D *rv3d);
373
374 /* camera lock functions */
375 bool ED_view3d_camera_lock_check(const struct View3D *v3d, const struct RegionView3D *rv3d);
376 /* copy the camera to the view before starting a view transformation */
377 void ED_view3d_camera_lock_init_ex(struct View3D *v3d, struct RegionView3D *rv3d, const bool calc_dist);
378 void ED_view3d_camera_lock_init(struct View3D *v3d, struct RegionView3D *rv3d);
379 /* copy the view to the camera, return true if */
380 bool ED_view3d_camera_lock_sync(struct View3D *v3d, struct RegionView3D *rv3d);
381
382 bool ED_view3d_camera_autokey(
383         struct Scene *scene, struct ID *id_key,
384         struct bContext *C, const bool do_rotate, const bool do_translate);
385 bool ED_view3d_camera_lock_autokey(
386         struct View3D *v3d, struct RegionView3D *rv3d,
387         struct bContext *C, const bool do_rotate, const bool do_translate);
388
389 void ED_view3D_lock_clear(struct View3D *v3d);
390
391 struct BGpic *ED_view3D_background_image_new(struct View3D *v3d);
392 void ED_view3D_background_image_remove(struct View3D *v3d, struct BGpic *bgpic);
393 void ED_view3D_background_image_clear(struct View3D *v3d);
394
395 #define VIEW3D_MARGIN 1.4f
396 #define VIEW3D_DIST_FALLBACK 1.0f
397
398 float ED_view3d_offset_distance(float mat[4][4], const float ofs[3], const float dist_fallback);
399 void  ED_view3d_distance_set(struct RegionView3D *rv3d, const float dist);
400
401 float ED_scene_grid_scale(struct Scene *scene, const char **grid_unit);
402 float ED_view3d_grid_scale(struct Scene *scene, struct View3D *v3d, const char **grid_unit);
403
404 void ED_scene_draw_fps(struct Scene *scene, const struct rcti *rect);
405
406 /* view matrix properties utilities */
407 /* unused */
408 #if 0
409 void ED_view3d_operator_properties_viewmat(struct wmOperatorType *ot);
410 void ED_view3d_operator_properties_viewmat_set(struct bContext *C, struct wmOperator *op);
411 void ED_view3d_operator_properties_viewmat_get(struct wmOperator *op, int *winx, int *winy, float persmat[4][4]);
412 #endif
413
414 /* render */
415 void ED_view3d_stop_render_preview(struct wmWindowManager *wm, struct ARegion *ar);
416 void ED_view3d_shade_update(struct Main *bmain, struct Scene *scene, struct View3D *v3d, struct ScrArea *sa);
417
418 #define V3D_IS_ZBUF(v3d) \
419         (((v3d)->flag & V3D_ZBUF_SELECT) && ((v3d)->drawtype > OB_WIRE))
420
421 void ED_view3d_id_remap(struct View3D *v3d, const struct ID *old_id, struct ID *new_id);
422
423 #endif /* __ED_VIEW3D_H__ */