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