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