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