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