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