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 Base;
41 struct BezTriple;
42 struct BoundBox;
43 struct Camera;
44 struct Depsgraph;
45 struct EditBone;
46 struct ImBuf;
47 struct MVert;
48 struct Main;
49 struct MetaElem;
50 struct Nurb;
51 struct Object;
52 struct RV3DMatrixStore;
53 struct RegionView3D;
54 struct RenderEngineType;
55 struct Scene;
56 struct ViewLayer;
57 struct ScrArea;
58 struct View3D;
59 struct ViewContext;
60 struct bContext;
61 struct bPoseChannel;
62 struct bScreen;
63 struct rctf;
64 struct rcti;
65 struct wmOperator;
66 struct wmOperatorType;
67 struct wmWindow;
68 struct wmWindowManager;
69 struct GPUFX;
70 struct GPUOffScreen;
71 struct GPUFXSettings;
72 struct GPUViewport;
73 struct WorkSpace;
74 enum eGPUFXFlags;
75
76 /* for derivedmesh drawing callbacks, for view3d_select, .... */
77 typedef struct ViewContext {
78         struct Main *bmain;
79         struct Depsgraph *depsgraph;
80         struct Scene *scene;
81         struct ViewLayer *view_layer;
82         struct Object *obact;
83         struct Object *obedit;
84         struct ARegion *ar;
85         struct View3D *v3d;
86         struct wmWindow *win;
87         struct RegionView3D *rv3d;
88         struct BMEditMesh *em;
89         int mval[2];
90 } ViewContext;
91
92 typedef struct ViewDepths {
93         unsigned short w, h;
94         short x, y; /* only for temp use for sub-rects, added to ar->winx/y */
95         float *depths;
96         double depth_range[2];
97
98         bool damaged;
99 } ViewDepths;
100
101
102 /* Rotate 3D cursor on placement. */
103 enum eV3DCursorOrient {
104         V3D_CURSOR_ORIENT_NONE = 0,
105         V3D_CURSOR_ORIENT_VIEW,
106         V3D_CURSOR_ORIENT_XFORM,
107         V3D_CURSOR_ORIENT_GEOM,
108 };
109
110 struct View3DCursor *ED_view3d_cursor3d_get(struct Scene *scene, struct View3D *v3d);
111 void ED_view3d_cursor3d_calc_mat3(const struct Scene *scene, const struct View3D *v3d, float mat[3][3]);
112 void ED_view3d_cursor3d_calc_mat4(const struct Scene *scene, const struct View3D *v3d, float mat[4][4]);
113 void ED_view3d_cursor3d_position(
114         struct bContext *C, const int mval[2],
115         const bool use_depth,
116         float cursor_co[3]);
117 void ED_view3d_cursor3d_position_rotation(
118         struct bContext *C, const int mval[2],
119         const bool use_depth, enum eV3DCursorOrient orientation,
120         float cursor_co[3], float cursor_quat[4]);
121 void ED_view3d_cursor3d_update(
122         struct bContext *C, const int mval[2],
123         const bool use_depth, enum eV3DCursorOrient orientation);
124
125 struct Camera *ED_view3d_camera_data_get(struct View3D *v3d, struct RegionView3D *rv3d);
126
127 void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], const float dist);
128 void ED_view3d_from_m4(const float mat[4][4], float ofs[3], float quat[4], float *dist);
129
130 void ED_view3d_from_object(
131         const struct Object *ob,
132         float ofs[3], float quat[4], float *dist, float *lens);
133 void ED_view3d_to_object(
134         const struct Depsgraph *depsgraph, struct Object *ob,
135         const float ofs[3], const float quat[4], const float dist);
136
137 void ED_view3d_lastview_store(struct RegionView3D *rv3d);
138
139 /* Depth buffer */
140 void  ED_view3d_depth_update(struct ARegion *ar);
141 float ED_view3d_depth_read_cached(const struct ViewContext *vc, const int mval[2]);
142 bool  ED_view3d_depth_read_cached_normal(
143         const ViewContext *vc, const int mval[2],
144         float r_normal[3]);
145 bool ED_view3d_depth_unproject(
146         const struct ARegion *ar,
147         const int mval[2], const double depth,
148         float r_location_world[3]);
149 void  ED_view3d_depth_tag_update(struct RegionView3D *rv3d);
150
151 /* Projection */
152 #define IS_CLIPPED        12000
153
154 /* return values for ED_view3d_project_...() */
155 typedef enum {
156         V3D_PROJ_RET_OK   = 0,
157         V3D_PROJ_RET_CLIP_NEAR = 1,  /* can't avoid this when in perspective mode, (can't avoid) */
158         V3D_PROJ_RET_CLIP_ZERO = 2,  /* so close to zero we can't apply a perspective matrix usefully */
159         V3D_PROJ_RET_CLIP_BB   = 3,  /* bounding box clip - RV3D_CLIPPING */
160         V3D_PROJ_RET_CLIP_WIN  = 4,  /* outside window bounds */
161         V3D_PROJ_RET_OVERFLOW  = 5   /* outside range (mainly for short), (can't avoid) */
162 } eV3DProjStatus;
163
164 /* some clipping tests are optional */
165 typedef enum {
166         V3D_PROJ_TEST_NOP        = 0,
167         V3D_PROJ_TEST_CLIP_BB    = (1 << 0),
168         V3D_PROJ_TEST_CLIP_WIN   = (1 << 1),
169         V3D_PROJ_TEST_CLIP_NEAR  = (1 << 2),
170         V3D_PROJ_TEST_CLIP_ZERO  = (1 << 3)
171 } eV3DProjTest;
172
173 #define V3D_PROJ_TEST_CLIP_DEFAULT \
174         (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN | V3D_PROJ_TEST_CLIP_NEAR)
175 #define V3D_PROJ_TEST_ALL \
176         (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN | V3D_PROJ_TEST_CLIP_NEAR | V3D_PROJ_TEST_CLIP_ZERO)
177
178
179 /* view3d_iterators.c */
180
181 /* foreach iterators */
182 void meshobject_foreachScreenVert(
183         struct ViewContext *vc,
184         void (*func)(void *userData, struct MVert *eve, const float screen_co[2], int index),
185         void *userData, const eV3DProjTest clip_flag);
186 void mesh_foreachScreenVert(
187         struct ViewContext *vc,
188         void (*func)(void *userData, struct BMVert *eve, const float screen_co[2], int index),
189         void *userData, const eV3DProjTest clip_flag);
190 void mesh_foreachScreenEdge(
191         struct ViewContext *vc,
192         void (*func)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2],
193                      int index),
194         void *userData, const eV3DProjTest clip_flag);
195 void mesh_foreachScreenFace(
196         struct ViewContext *vc,
197         void (*func)(void *userData, struct BMFace *efa, const float screen_co[2], int index),
198         void *userData, const eV3DProjTest clip_flag);
199 void nurbs_foreachScreenVert(
200         struct ViewContext *vc,
201         void (*func)(void *userData, struct Nurb *nu, struct BPoint *bp, struct BezTriple *bezt,
202                      int beztindex, const float screen_co[2]),
203         void *userData, const eV3DProjTest clip_flag);
204 void mball_foreachScreenElem(
205         struct ViewContext *vc,
206         void (*func)(void *userData, struct MetaElem *ml, const float screen_co[2]),
207         void *userData, const eV3DProjTest clip_flag);
208 void lattice_foreachScreenVert(
209         struct ViewContext *vc,
210         void (*func)(void *userData, struct BPoint *bp,
211                      const float screen_co[2]),
212         void *userData, const eV3DProjTest clip_flag);
213 void armature_foreachScreenBone(
214         struct ViewContext *vc,
215         void (*func)(void *userData, struct EditBone *ebone,
216                      const float screen_co_a[2], const float screen_co_b[2]),
217         void *userData, const eV3DProjTest clip_flag);
218 void pose_foreachScreenBone(
219         struct ViewContext *vc,
220         void (*func)(void *userData, struct bPoseChannel *pchan,
221                      const float screen_co_a[2], const float screen_co_b[2]),
222         void *userData, const eV3DProjTest clip_flag);
223 /* *** end iterators *** */
224
225
226 /* view3d_project.c */
227 void ED_view3d_project_float_v2_m4(const struct ARegion *ar, const float co[3], float r_co[2], float mat[4][4]);
228 void ED_view3d_project_float_v3_m4(const struct ARegion *ar, const float co[3], float r_co[3], float mat[4][4]);
229
230 eV3DProjStatus ED_view3d_project_base(const struct ARegion *ar, struct Base *base);
231
232 /* *** short *** */
233 eV3DProjStatus ED_view3d_project_short_ex(const struct ARegion *ar, float perspmat[4][4], const bool is_local,
234                                           const float co[3], short r_co[2], const eV3DProjTest flag);
235 eV3DProjStatus ED_view3d_project_short_global(const struct ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag);
236 eV3DProjStatus ED_view3d_project_short_object(const struct ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag);
237
238 /* *** int *** */
239 eV3DProjStatus ED_view3d_project_int_ex(const struct ARegion *ar, float perspmat[4][4], const bool is_local,
240                                         const float co[3], int r_co[2], const eV3DProjTest flag);
241 eV3DProjStatus ED_view3d_project_int_global(const struct ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag);
242 eV3DProjStatus ED_view3d_project_int_object(const struct ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag);
243
244 /* *** float *** */
245 eV3DProjStatus ED_view3d_project_float_ex(const struct ARegion *ar, float perspmat[4][4], const bool is_local,
246                                           const float co[3], float r_co[2], const eV3DProjTest flag);
247 eV3DProjStatus ED_view3d_project_float_global(const struct ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag);
248 eV3DProjStatus ED_view3d_project_float_object(const struct ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag);
249
250 float ED_view3d_pixel_size(const struct RegionView3D *rv3d, const float co[3]);
251 float ED_view3d_pixel_size_no_ui_scale(const struct RegionView3D *rv3d, const float co[3]);
252
253 float ED_view3d_calc_zfac(const struct RegionView3D *rv3d, const float co[3], bool *r_flip);
254 bool ED_view3d_clip_segment(const struct RegionView3D *rv3d, float ray_start[3], float ray_end[3]);
255 bool ED_view3d_win_to_ray_clipped(
256         struct Depsgraph *depsgraph,
257         const struct ARegion *ar, const struct View3D *v3d, const float mval[2],
258         float ray_start[3], float ray_normal[3], const bool do_clip);
259 bool ED_view3d_win_to_ray_clipped_ex(
260         struct Depsgraph *depsgraph,
261         const struct ARegion *ar, const struct View3D *v3d, const float mval[2],
262         float r_ray_co[3], float r_ray_normal[3], float r_ray_start[3], bool do_clip);
263 void ED_view3d_win_to_ray(
264         const struct ARegion *ar, const float mval[2],
265         float r_ray_start[3], float r_ray_normal[3]);
266 void ED_view3d_global_to_vector(const struct RegionView3D *rv3d, const float coord[3], float vec[3]);
267 void ED_view3d_win_to_3d(
268         const struct View3D *v3d, const struct ARegion *ar,
269         const float depth_pt[3], const float mval[2],
270         float r_out[3]);
271 void ED_view3d_win_to_3d_int(
272         const struct View3D *v3d, const struct ARegion *ar,
273         const float depth_pt[3], const int mval[2],
274         float r_out[3]);
275 bool ED_view3d_win_to_3d_on_plane(
276         const struct ARegion *ar,
277         const float plane[4], const float mval[2], const bool do_clip,
278         float r_out[3]);
279 bool ED_view3d_win_to_3d_on_plane_int(
280         const struct ARegion *ar,
281         const float plane[4], const int mval[2], const bool do_clip,
282         float r_out[3]);
283 void ED_view3d_win_to_delta(const struct ARegion *ar, const float mval[2], float out[3], const float zfac);
284 void ED_view3d_win_to_origin(const struct ARegion *ar, const float mval[2], float out[3]);
285 void ED_view3d_win_to_vector(const struct ARegion *ar, const float mval[2], float out[3]);
286 bool ED_view3d_win_to_segment_clipped(
287         struct Depsgraph *depsgraph,
288         const struct ARegion *ar, struct View3D *v3d, const float mval[2],
289         float r_ray_start[3], float r_ray_end[3], const bool do_clip);
290 void ED_view3d_ob_project_mat_get(const struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
291 void ED_view3d_ob_project_mat_get_from_obmat(const struct RegionView3D *rv3d, float obmat[4][4], float pmat[4][4]);
292
293 void ED_view3d_project(const struct ARegion *ar, const float world[3], float region[3]);
294 bool ED_view3d_unproject(const struct ARegion *ar, float regionx, float regiony, float regionz, float world[3]);
295
296 /* end */
297
298
299 void ED_view3d_dist_range_get(
300         const struct View3D *v3d,
301         float r_dist_range[2]);
302 bool ED_view3d_clip_range_get(
303         struct Depsgraph *depsgraph,
304         const struct View3D *v3d, const struct RegionView3D *rv3d,
305         float *r_clipsta, float *r_clipend, const bool use_ortho_factor);
306 bool ED_view3d_viewplane_get(
307         struct Depsgraph *depsgraph,
308         const struct View3D *v3d, const struct RegionView3D *rv3d, int winxi, int winyi,
309         struct rctf *r_viewplane, float *r_clipsta, float *r_clipend, float *r_pixsize);
310
311 void ED_view3d_polygon_offset(const struct RegionView3D *rv3d, const float dist);
312
313 void ED_view3d_calc_camera_border(
314         const struct Scene *scene, struct Depsgraph *depsgraph,
315         const struct ARegion *ar,
316         const struct View3D *v3d, const struct RegionView3D *rv3d,
317         struct rctf *r_viewborder, const bool no_shift);
318 void ED_view3d_calc_camera_border_size(
319         const struct Scene *scene, struct Depsgraph *depsgraph,
320         const struct ARegion *ar,
321         const struct View3D *v3d, const struct RegionView3D *rv3d,
322         float r_size[2]);
323 bool ED_view3d_calc_render_border(
324         const struct Scene *scene, struct Depsgraph *depsgraph,
325         struct View3D *v3d,
326         struct ARegion *ar, struct rcti *rect);
327
328 void ED_view3d_clipping_calc_from_boundbox(float clip[6][4], const struct BoundBox *clipbb, const bool is_flip);
329 void ED_view3d_clipping_calc(struct BoundBox *bb, float planes[4][4],
330         const struct ARegion *ar, const struct Object *ob, const struct rcti *rect);
331 void ED_view3d_clipping_local(struct RegionView3D *rv3d, float mat[4][4]);
332 bool ED_view3d_clipping_test(const struct RegionView3D *rv3d, const float co[3], const bool is_local);
333 void ED_view3d_clipping_set(struct RegionView3D *rv3d);
334 void ED_view3d_clipping_enable(void);
335 void ED_view3d_clipping_disable(void);
336
337 float ED_view3d_radius_to_dist_persp(const float angle, const float radius);
338 float ED_view3d_radius_to_dist_ortho(const float lens, const float radius);
339 float ED_view3d_radius_to_dist(
340         const struct View3D *v3d, const struct ARegion *ar,
341         const struct Depsgraph *depsgraph,
342         const char persp, const bool use_aspect,
343         const float radius);
344
345 void imm_drawcircball(const float cent[3], float rad, const float tmat[4][4], unsigned pos);
346
347 /* backbuffer select and draw support */
348 void          ED_view3d_backbuf_validate_with_select_mode(struct ViewContext *vc, short select_mode);
349 void          ED_view3d_backbuf_validate(struct ViewContext *vc);
350 struct ImBuf *ED_view3d_backbuf_read(
351         struct ViewContext *vc, int xmin, int ymin, int xmax, int ymax);
352 unsigned int  ED_view3d_backbuf_sample_rect(
353         struct ViewContext *vc, const int mval[2], int size,
354         unsigned int min, unsigned int max, float *r_dist);
355 int          ED_view3d_backbuf_sample_size_clamp(struct ARegion *ar, const float dist);
356 unsigned int ED_view3d_backbuf_sample(
357         struct ViewContext *vc, int x, int y);
358
359 bool ED_view3d_autodist(
360         struct Depsgraph *depsgraph, struct ARegion *ar, struct View3D *v3d,
361         const int mval[2], float mouse_worldloc[3],
362         const bool alphaoverride, const float fallback_depth_pt[3]);
363
364 /* only draw so ED_view3d_autodist_simple can be called many times after */
365 void ED_view3d_autodist_init(
366         struct Depsgraph *depsgraph, struct ARegion *ar, struct View3D *v3d, int mode);
367 bool ED_view3d_autodist_simple(struct ARegion *ar, const int mval[2], float mouse_worldloc[3], int margin, float *force_depth);
368 bool ED_view3d_autodist_depth(struct ARegion *ar, const int mval[2], int margin, float *depth);
369 bool ED_view3d_autodist_depth_seg(struct ARegion *ar, const int mval_sta[2], const int mval_end[2], int margin, float *depth);
370
371 /* select */
372 #define MAXPICKELEMS    2500
373 #define MAXPICKBUF      (4 * MAXPICKELEMS)
374
375 typedef enum {
376         /* all elements in the region, ignore depth */
377         VIEW3D_SELECT_ALL = 0,
378         /* pick also depth sorts (only for small regions!) */
379         VIEW3D_SELECT_PICK_ALL = 1,
380         /* sorts and only returns visible objects (only for small regions!) */
381         VIEW3D_SELECT_PICK_NEAREST = 2,
382 } eV3DSelectMode;
383
384 typedef enum {
385         /* Don't exclude anything. */
386         VIEW3D_SELECT_FILTER_NOP = 0,
387         /* Don't select objects outside the current mode. */
388         VIEW3D_SELECT_FILTER_OBJECT_MODE_LOCK = 1,
389 } eV3DSelectObjectFilter;
390
391 void view3d_opengl_select_cache_begin(void);
392 void view3d_opengl_select_cache_end(void);
393
394 int view3d_opengl_select(
395         struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, const struct rcti *input,
396         eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter);
397
398 /* view3d_select.c */
399 float ED_view3d_select_dist_px(void);
400 void ED_view3d_viewcontext_init(struct bContext *C, struct ViewContext *vc);
401 void ED_view3d_viewcontext_init_object(struct ViewContext *vc, struct Object *obact);
402 void view3d_operator_needs_opengl(const struct bContext *C);
403 void view3d_region_operator_needs_opengl(struct wmWindow *win, struct ARegion *ar);
404 void view3d_opengl_read_pixels(struct ARegion *ar, int x, int y, int w, int h, int format, int type, void *data);
405
406 /* XXX should move to BLI_math */
407 bool edge_inside_circle(const float cent[2], float radius, const float screen_co_a[2], const float screen_co_b[2]);
408
409 /* get 3d region from context, also if mouse is in header or toolbar */
410 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
411 bool ED_view3d_context_user_region(struct bContext *C, struct View3D **r_v3d, struct ARegion **r_ar);
412 bool ED_operator_rv3d_user_region_poll(struct bContext *C);
413
414 void ED_view3d_init_mats_rv3d(struct Object *ob, struct RegionView3D *rv3d);
415 void ED_view3d_init_mats_rv3d_gl(struct Object *ob, struct RegionView3D *rv3d);
416 #ifdef DEBUG
417 void ED_view3d_clear_mats_rv3d(struct RegionView3D *rv3d);
418 void ED_view3d_check_mats_rv3d(struct RegionView3D *rv3d);
419 #else
420 #  define ED_view3d_clear_mats_rv3d(rv3d) (void)(rv3d)
421 #  define ED_view3d_check_mats_rv3d(rv3d) (void)(rv3d)
422 #endif
423 int ED_view3d_view_layer_set(int lay, const bool *values, int *active);
424
425 struct RV3DMatrixStore *ED_view3d_mats_rv3d_backup(struct RegionView3D *rv3d);
426 void                    ED_view3d_mats_rv3d_restore(struct RegionView3D *rv3d, struct RV3DMatrixStore *rv3dmat);
427
428 void  ED_draw_object_facemap(
429         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, const float col[4], const int facemap);
430
431 struct RenderEngineType *ED_view3d_engine_type(struct Scene *scene, int drawtype);
432
433 bool ED_view3d_context_activate(struct bContext *C);
434 void ED_view3d_draw_offscreen(
435         struct Depsgraph *depsgraph, struct Scene *scene,
436         int drawtype,
437         struct View3D *v3d, struct ARegion *ar, int winx, int winy, float viewmat[4][4],
438         float winmat[4][4], bool do_sky, bool is_persp, const char *viewname,
439         struct GPUFXSettings *fx_settings,
440         struct GPUOffScreen *ofs, struct GPUViewport *viewport);
441 void ED_view3d_draw_setup_view(
442         struct wmWindow *win, struct Depsgraph *depsgraph, struct Scene *scene, struct ARegion *ar, struct View3D *v3d,
443         float viewmat[4][4], float winmat[4][4], const struct rcti *rect);
444
445 enum {
446         V3D_OFSDRAW_NONE             = (0),
447
448         V3D_OFSDRAW_USE_FULL_SAMPLE  = (1 << 0),
449
450         /* Only works with ED_view3d_draw_offscreen_imbuf_simple(). */
451         V3D_OFSDRAW_USE_GPENCIL      = (1 << 1),
452         V3D_OFSDRAW_USE_SOLID_TEX    = (1 << 2),
453         V3D_OFSDRAW_USE_CAMERA_DOF   = (1 << 3),
454 };
455
456 struct ImBuf *ED_view3d_draw_offscreen_imbuf(
457         struct Depsgraph *depsgraph, struct Scene *scene,
458         int drawtype,
459         struct View3D *v3d, struct ARegion *ar,
460         int sizex, int sizey, unsigned int flag, unsigned int draw_flags,
461         int alpha_mode, int samples, const char *viewname,
462         struct GPUOffScreen *ofs, char err_out[256]);
463 struct ImBuf *ED_view3d_draw_offscreen_imbuf_simple(
464         struct Depsgraph *depsgraph, struct Scene *scene,
465         int drawtype,
466         struct Object *camera, int width, int height,
467         unsigned int flag, unsigned int draw_flags, int alpha_mode,
468         int samples, const char *viewname,
469         struct GPUOffScreen *ofs, char err_out[256]);
470
471 struct Base *ED_view3d_give_base_under_cursor(struct bContext *C, const int mval[2]);
472 void ED_view3d_quadview_update(struct ScrArea *sa, struct ARegion *ar, bool do_clip);
473 void ED_view3d_update_viewmat(
474         struct Depsgraph *depsgraph, struct Scene *scene, struct View3D *v3d, struct ARegion *ar,
475         float viewmat[4][4], float winmat[4][4], const struct rcti *rect);
476 bool ED_view3d_quat_from_axis_view(const char view, float quat[4]);
477 char ED_view3d_quat_to_axis_view(const float quat[4], const float epsilon);
478 char ED_view3d_lock_view_from_index(int index);
479 char ED_view3d_axis_view_opposite(char view);
480 bool ED_view3d_lock(struct RegionView3D *rv3d);
481
482 uint64_t ED_view3d_datamask(const struct Scene *scene, const struct View3D *v3d);
483 uint64_t ED_view3d_screen_datamask(const struct Scene *scene, const struct bScreen *screen);
484
485 bool ED_view3d_offset_lock_check(const struct View3D *v3d, const struct RegionView3D *rv3d);
486 void ED_view3d_persp_switch_from_camera(
487         const struct Depsgraph *depsgraph,
488         struct View3D *v3d, struct RegionView3D *rv3d, const char persp);
489 bool ED_view3d_persp_ensure(
490         const struct Depsgraph *depsgraph,
491         struct View3D *v3d, struct ARegion *ar);
492
493
494 /* camera lock functions */
495 bool ED_view3d_camera_lock_check(const struct View3D *v3d, const struct RegionView3D *rv3d);
496 /* copy the camera to the view before starting a view transformation */
497 void ED_view3d_camera_lock_init_ex(
498         const struct Depsgraph *depsgraph,
499         struct View3D *v3d, struct RegionView3D *rv3d, const bool calc_dist);
500 void ED_view3d_camera_lock_init(const struct Depsgraph *depsgraph, struct View3D *v3d, struct RegionView3D *rv3d);
501 /* copy the view to the camera, return true if */
502 bool ED_view3d_camera_lock_sync(
503         const struct Depsgraph *depsgraph,
504         struct View3D *v3d, struct RegionView3D *rv3d);
505
506 bool ED_view3d_camera_autokey(
507         struct Scene *scene, struct ID *id_key,
508         struct bContext *C, const bool do_rotate, const bool do_translate);
509 bool ED_view3d_camera_lock_autokey(
510         struct View3D *v3d, struct RegionView3D *rv3d,
511         struct bContext *C, const bool do_rotate, const bool do_translate);
512
513 void ED_view3d_lock_clear(struct View3D *v3d);
514
515 #define VIEW3D_MARGIN 1.4f
516 #define VIEW3D_DIST_FALLBACK 1.0f
517
518 float ED_view3d_offset_distance(float mat[4][4], const float ofs[3], const float dist_fallback);
519 void  ED_view3d_distance_set(struct RegionView3D *rv3d, const float dist);
520
521 float ED_scene_grid_scale(struct Scene *scene, const char **grid_unit);
522 float ED_view3d_grid_scale(struct Scene *scene, struct View3D *v3d, const char **grid_unit);
523
524 void ED_scene_draw_fps(struct Scene *scene, const struct rcti *rect);
525
526 /* view matrix properties utilities */
527 /* unused */
528 #if 0
529 void ED_view3d_operator_properties_viewmat(struct wmOperatorType *ot);
530 void ED_view3d_operator_properties_viewmat_set(struct bContext *C, struct wmOperator *op);
531 void ED_view3d_operator_properties_viewmat_get(struct wmOperator *op, int *winx, int *winy, float persmat[4][4]);
532 #endif
533
534 /* render */
535 void ED_view3d_stop_render_preview(struct wmWindowManager *wm, struct ARegion *ar);
536 void ED_view3d_shade_update(struct Main *bmain, struct View3D *v3d, struct ScrArea *sa);
537
538 #define V3D_IS_ZBUF(v3d) \
539         (((v3d)->flag & V3D_ZBUF_SELECT) && ((v3d)->shading.type > OB_WIRE))
540
541 void ED_view3d_id_remap(struct View3D *v3d, const struct ID *old_id, struct ID *new_id);
542
543 /* view3d_draw_legacy.c */
544 /* Try avoid using these more move out of legacy. */
545 void ED_view3d_draw_bgpic_test(
546         struct Scene *scene, struct Depsgraph *depsgraph,
547         struct ARegion *ar, struct View3D *v3d,
548         const bool do_foreground, const bool do_camera_frame);
549
550 #endif /* __ED_VIEW3D_H__ */