code cleanup:
[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 BezTriple;
43 struct BoundBox;
44 struct EditBone;
45 struct ImBuf;
46 struct MVert;
47 struct Main;
48 struct MetaElem;
49 struct Nurb;
50 struct Nurb;
51 struct Object;
52 struct RegionView3D;
53 struct Scene;
54 struct ScrArea;
55 struct View3D;
56 struct ViewContext;
57 struct bContext;
58 struct bPoseChannel;
59 struct bScreen;
60 struct bglMats;
61 struct rcti;
62 struct wmOperator;
63 struct wmOperatorType;
64 struct wmWindow;
65
66 /* for derivedmesh drawing callbacks, for view3d_select, .... */
67 typedef struct ViewContext {
68         struct Scene *scene;
69         struct Object *obact;
70         struct Object *obedit;
71         struct ARegion *ar;
72         struct View3D *v3d;
73         struct RegionView3D *rv3d;
74         struct BMEditMesh *em;
75         int mval[2];
76 } ViewContext;
77
78 typedef struct ViewDepths {
79         unsigned short w, h;
80         short x, y; /* only for temp use for sub-rects, added to ar->winx/y */
81         float *depths;
82         double depth_range[2];
83         
84         char damaged;
85 } ViewDepths;
86
87 float *give_cursor(struct Scene *scene, struct View3D *v3d);
88
89 void ED_view3d_to_m4(float mat[][4], const float ofs[3], const float quat[4], const float dist);
90 void ED_view3d_from_m4(float mat[][4], float ofs[3], float quat[4], float *dist);
91
92 void ED_view3d_from_object(struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens);
93 void ED_view3d_to_object(struct Object *ob, const float ofs[3], const float quat[4], const float dist);
94
95 /* Depth buffer */
96 void  ED_view3d_depth_update(struct ARegion *ar);
97 float ED_view3d_depth_read_cached(struct ViewContext *vc, int x, int y);
98 void  ED_view3d_depth_tag_update(struct RegionView3D *rv3d);
99
100 /* Projection */
101 #define IS_CLIPPED        12000
102
103 /* TODO, these functions work quite differently, we should make them behave in a uniform way
104  * otherwise we can't be sure bugs are not added when we need to move from short->float types for eg
105  * - Campbell */
106
107
108 /* return values for ED_view3d_project_...() */
109 typedef enum {
110         V3D_PROJ_RET_OK   = 0,
111         V3D_PROJ_RET_CLIP_NEAR = 1,  /* can't avoid this when in perspective mode, (can't avoid) */
112         V3D_PROJ_RET_CLIP_BB   = 2,  /* bounding box clip - RV3D_CLIPPING */
113         V3D_PROJ_RET_CLIP_WIN  = 3,  /* outside window bounds */
114         V3D_PROJ_RET_OVERFLOW  = 4   /* outside range (mainly for short), (can't avoid) */
115 } eV3DProjStatus;
116
117 /* some clipping tests are optional */
118 typedef enum {
119         V3D_PROJ_TEST_NOP        = 0,
120         V3D_PROJ_TEST_CLIP_BB    = (1 << 0),
121         V3D_PROJ_TEST_CLIP_WIN   = (1 << 1),
122 } eV3DProjTest;
123
124 #define V3D_PROJ_TEST_CLIP_DEFAULT (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN)
125 #define V3D_PROJ_TEST_ALL          (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN)
126
127
128 /* view3d_iterators.c */
129
130 /* foreach iterators */
131 void mesh_foreachScreenVert(
132         struct ViewContext *vc,
133         void (*func)(void *userData, struct BMVert *eve, const float screen_co[2], int index),
134         void *userData, const eV3DProjTest clip_flag);
135 void mesh_foreachScreenEdge(
136         struct ViewContext *vc,
137         void (*func)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2],
138                      int index),
139         void *userData, const eV3DProjTest clip_flag);
140 void mesh_foreachScreenFace(
141         struct ViewContext *vc,
142         void (*func)(void *userData, struct BMFace *efa, const float screen_co[2], int index),
143         void *userData, const eV3DProjTest clip_flag);
144 void nurbs_foreachScreenVert(
145         struct ViewContext *vc,
146         void (*func)(void *userData, struct Nurb *nu, struct BPoint *bp, struct BezTriple *bezt,
147                      int beztindex, const float screen_co[2]),
148         void *userData, const eV3DProjTest clip_flag);
149 void mball_foreachScreenElem(
150         struct ViewContext *vc,
151         void (*func)(void *userData, struct MetaElem *ml, const float screen_co[2]),
152         void *userData, const eV3DProjTest clip_flag);
153 void lattice_foreachScreenVert(
154         struct ViewContext *vc,
155         void (*func)(void *userData, struct BPoint *bp,
156                      const float screen_co[2]),
157         void *userData, const eV3DProjTest clip_flag);
158 void armature_foreachScreenBone(
159         struct ViewContext *vc,
160         void (*func)(void *userData, struct EditBone *ebone,
161                      const float screen_co_a[2], const float screen_co_b[2]),
162         void *userData, const eV3DProjTest clip_flag);
163 void pose_foreachScreenBone(
164         struct ViewContext *vc,
165         void (*func)(void *userData, struct bPoseChannel *pchan,
166                      const float screen_co_a[2], const float screen_co_b[2]),
167         void *userData, const eV3DProjTest clip_flag);
168 /* *** end iterators *** */
169
170
171 /* view3d_project.c */
172 void ED_view3d_project_float_v2_m4(const struct ARegion *a, const float co[3], float r_co[2], float mat[4][4]);
173 void ED_view3d_project_float_v3_m4(struct ARegion *a, const float co[3], float r_co[3], float mat[4][4]);
174
175 eV3DProjStatus ED_view3d_project_base(struct ARegion *ar, struct Base *base);
176
177 /* *** short *** */
178 eV3DProjStatus ED_view3d_project_short_ex(struct ARegion *ar, float perspmat[4][4], const int is_local,
179                                           const float co[3], short r_co[2], const eV3DProjTest flag);
180 eV3DProjStatus ED_view3d_project_short_global(struct ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag);
181 eV3DProjStatus ED_view3d_project_short_object(struct ARegion *ar, const float co[3], short r_co[2], const eV3DProjTest flag);
182
183 /* *** int *** */
184 eV3DProjStatus ED_view3d_project_int_ex(struct ARegion *ar, float perspmat[4][4], const int is_local,
185                                         const float co[3], int r_co[2], const eV3DProjTest flag);
186 eV3DProjStatus ED_view3d_project_int_global(struct ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag);
187 eV3DProjStatus ED_view3d_project_int_object(struct ARegion *ar, const float co[3], int r_co[2], const eV3DProjTest flag);
188
189 /* *** float *** */
190 eV3DProjStatus ED_view3d_project_float_ex(struct ARegion *ar, float perspmat[4][4], const int is_local,
191                                         const float co[3], float r_co[2], const eV3DProjTest flag);
192 eV3DProjStatus ED_view3d_project_float_global(struct ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag);
193 eV3DProjStatus ED_view3d_project_float_object(struct ARegion *ar, const float co[3], float r_co[2], const eV3DProjTest flag);
194
195 int initgrabz(struct RegionView3D *rv3d, float x, float y, float z);
196 void ED_view3d_win_to_ray(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_normal[3]);
197 void ED_view3d_global_to_vector(struct RegionView3D *rv3d, const float coord[3], float vec[3]);
198 void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const float mval[2], float out[3]);
199 void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3]);
200 void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[3]);
201 void ED_view3d_win_to_segment_clip(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_end[3]);
202 void ED_view3d_ob_project_mat_get(struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
203 void ED_view3d_unproject(struct bglMats *mats, float out[3], const float x, const float y, const float z);
204
205 /* end */
206
207
208
209 int  ED_view3d_clip_range_get(struct View3D *v3d, struct RegionView3D *rv3d, float *clipsta, float *clipend);
210 int  ED_view3d_viewplane_get(struct View3D *v3d, struct RegionView3D *rv3d, int winxi, int winyi, struct rctf *viewplane, float *clipsta, float *clipend);
211 void ED_view3d_calc_camera_border(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, struct RegionView3D *rv3d, struct rctf *viewborder_r, short no_shift);
212 void ED_view3d_calc_camera_border_size(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, struct RegionView3D *rv3d, float size_r[2]);
213
214 void ED_view3d_clipping_calc(struct BoundBox *bb, float planes[4][4], struct bglMats *mats, const struct rcti *rect);
215 void ED_view3d_clipping_local(struct RegionView3D *rv3d, float mat[][4]);
216 int  ED_view3d_clipping_test(struct RegionView3D *rv3d, const float vec[3], const int is_local);
217 void ED_view3d_clipping_set(struct RegionView3D *rv3d);
218 void ED_view3d_clipping_enable(void);
219 void ED_view3d_clipping_disable(void);
220
221 float ED_view3d_pixel_size(struct RegionView3D *rv3d, const float co[3]);
222
223 void drawcircball(int mode, const float cent[3], float rad, float tmat[][4]);
224
225 /* backbuffer select and draw support */
226 void view3d_validate_backbuf(struct ViewContext *vc);
227 struct ImBuf *view3d_read_backbuf(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
228 unsigned int view3d_sample_backbuf_rect(struct ViewContext *vc, const int mval[2], int size,
229                                         unsigned int min, unsigned int max, float *dist, short strict,
230                                         void *handle, unsigned int (*indextest)(void *handle, unsigned int index));
231 unsigned int view3d_sample_backbuf(struct ViewContext *vc, int x, int y);
232
233 /* draws and does a 4x4 sample */
234 int ED_view3d_autodist(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, const int mval[2], float mouse_worldloc[3]);
235
236 /* only draw so ED_view3d_autodist_simple can be called many times after */
237 int ED_view3d_autodist_init(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, int mode);
238 int ED_view3d_autodist_simple(struct ARegion *ar, const int mval[2], float mouse_worldloc[3], int margin, float *force_depth);
239 int ED_view3d_autodist_depth(struct ARegion *ar, const int mval[2], int margin, float *depth);
240 int ED_view3d_autodist_depth_seg(struct ARegion *ar, const int mval_sta[2], const int mval_end[2], int margin, float *depth);
241
242 /* select */
243 #define MAXPICKBUF      10000
244 short view3d_opengl_select(struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, rcti *input);
245
246 void view3d_set_viewcontext(struct bContext *C, struct ViewContext *vc);
247 void view3d_operator_needs_opengl(const struct bContext *C);
248 void view3d_region_operator_needs_opengl(struct wmWindow *win, struct ARegion *ar);
249 int view3d_get_view_aligned_coordinate(struct ViewContext *vc, float fp[3], const int mval[2], const short do_fallback);
250 void view3d_get_transformation(const struct ARegion *ar, struct RegionView3D *rv3d, struct Object *ob, struct bglMats *mats);
251
252 /* XXX should move to BLI_math */
253 int edge_inside_circle(const float cent[2], float radius, const float screen_co_a[2], const float screen_co_b[2]);
254
255 /* get 3d region from context, also if mouse is in header or toolbar */
256 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
257 int ED_view3d_context_user_region(struct bContext *C, struct View3D **v3d_r, struct ARegion **ar_r);
258 int ED_operator_rv3d_user_region_poll(struct bContext *C);
259
260 void ED_view3d_init_mats_rv3d(struct Object *ob, struct RegionView3D *rv3d);
261 void ED_view3d_init_mats_rv3d_gl(struct Object *ob, struct RegionView3D *rv3d);
262
263 int ED_view3d_scene_layer_set(int lay, const int *values, int *active);
264
265 int ED_view3d_context_activate(struct bContext *C);
266 void ED_view3d_draw_offscreen(struct Scene *scene, struct View3D *v3d, struct ARegion *ar,
267                               int winx, int winy, float viewmat[][4], float winmat[][4], int do_bgpic, int colormanage_background);
268
269 struct ImBuf *ED_view3d_draw_offscreen_imbuf(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, int sizex, int sizey, unsigned int flag,
270                                              int draw_background, int colormanage_background, char err_out[256]);
271 struct ImBuf *ED_view3d_draw_offscreen_imbuf_simple(struct Scene *scene, struct Object *camera, int width, int height, unsigned int flag, int drawtype,
272                                                     int draw_background, int colormanage_background, char err_out[256]);
273
274
275 struct Base *ED_view3d_give_base_under_cursor(struct bContext *C, const int mval[2]);
276 void ED_view3d_quadview_update(struct ScrArea *sa, struct ARegion *ar, short do_clip);
277 void ED_view3d_update_viewmat(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, float viewmat[][4], float winmat[][4]);
278 int ED_view3d_lock(struct RegionView3D *rv3d);
279
280 uint64_t ED_view3d_datamask(struct Scene *scene, struct View3D *v3d);
281 uint64_t ED_view3d_screen_datamask(struct bScreen *screen);
282 uint64_t ED_view3d_object_datamask(struct Scene *scene);
283
284 /* camera lock functions */
285 int ED_view3d_camera_lock_check(struct View3D *v3d, struct RegionView3D *rv3d);
286 /* copy the camera to the view before starting a view transformation */
287 void ED_view3d_camera_lock_init(struct View3D *v3d, struct RegionView3D *rv3d);
288 /* copy the view to the camera, return TRUE if */
289 int ED_view3d_camera_lock_sync(struct View3D *v3d, struct RegionView3D *rv3d);
290
291 void ED_view3D_lock_clear(struct View3D *v3d);
292
293 struct BGpic *ED_view3D_background_image_new(struct View3D *v3d);
294 void ED_view3D_background_image_remove(struct View3D *v3d, struct BGpic *bgpic);
295 void ED_view3D_background_image_clear(struct View3D *v3d);
296
297 float ED_view3d_grid_scale(struct Scene *scene, struct View3D *v3d, const char **grid_unit);
298
299 /* view matrix properties utilities */
300 /* unused */
301 #if 0
302 void ED_view3d_operator_properties_viewmat(struct wmOperatorType *ot);
303 void ED_view3d_operator_properties_viewmat_set(struct bContext *C, struct wmOperator *op);
304 void ED_view3d_operator_properties_viewmat_get(struct wmOperator *op, int *winx, int *winy, float persmat[4][4]);
305 #endif
306
307 #endif /* __ED_VIEW3D_H__ */