svn merge ^/trunk/blender -r44136:44189
[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 bContext;
37 struct BezTriple;
38 struct bglMats;
39 struct BoundBox;
40 struct BPoint;
41 struct Nurb;
42 struct BezTriple;
43 struct BMVert;
44 struct BMEdge;
45 struct BMFace;
46 struct EditVert;
47 struct ImBuf;
48 struct Main;
49 struct Nurb;
50 struct Object;
51 struct rcti;
52 struct RegionView3D;
53 struct Scene;
54 struct View3D;
55 struct ViewContext;
56 struct wmWindow;
57 struct MVert;
58 struct wmOperatorType;
59 struct wmOperator;
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 /**
94  * Calculate a 3d location from 2d window coordinates.
95  * @param ar The region (used for the window width and height).
96  * @param depth_pt The reference location used to calculate the Z depth.
97  * @param mval The area relative location (such as event->mval converted to floats).
98  * @param out The resulting world-space location.
99  */
100 void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const float mval[2], float out[3]);
101
102 /**
103  * Calculate a 3d difference vector from 2d window offset.
104  * note that initgrabz() must be called first to determine
105  * the depth used to calculate the delta.
106  * @param ar The region (used for the window width and height).
107  * @param mval The area relative 2d difference (such as event->mval[0] - other_x).
108  * @param out The resulting world-space delta.
109  */
110 void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3]);
111
112 /**
113  * Calculate a 3d direction vector from 2d window coordinates.
114  * This direction vector starts and the view in the direction of the 2d window coordinates.
115  * In orthographic view all window coordinates yield the same vector.
116  * @param ar The region (used for the window width and height).
117  * @param mval The area relative 2d location (such as event->mval converted to floats).
118  * @param out The resulting normalized world-space direction vector.
119  */
120 void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[3]);
121
122 /**
123  * Calculate a 3d segment from 2d window coordinates.
124  * This ray_start is located at the viewpoint, ray_end is a far point.
125  * ray_start and ray_end are clipped by the view near and far limits
126  * so points along this line are always in view.
127  * In orthographic view all resulting segments will be parallel.
128  * @param ar The region (used for the window width and height).
129  * @param v3d The 3d viewport (used for near and far clipping range).
130  * @param mval The area relative 2d location (such as event->mval, converted into float[2]).
131  * @param ray_start The world-space starting point of the segment.
132  * @param ray_end The world-space end point of the segment.
133  */
134 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]);
135
136 /**
137  * Calculate a 3d viewpoint and direction vector from 2d window coordinates.
138  * This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
139  * ray_start is clipped by the view near limit so points in front of it are always in view.
140  * In orthographic view the resulting ray_normal will match the view vector.
141  * @param ar The region (used for the window width and height).
142  * @param v3d The 3d viewport (used for near clipping value).
143  * @param mval The area relative 2d location (such as event->mval, converted into float[2]).
144  * @param ray_start The world-space starting point of the segment.
145  * @param ray_normal The normalized world-space direction of towards mval.
146  */
147 void ED_view3d_win_to_ray(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_normal[3]);
148
149 /**
150  * Calculate a normalized 3d direction vector from the viewpoint towards a global location.
151  * In orthographic view the resulting vector will match the view vector.
152  * @param rv3d The region (used for the window width and height).
153  * @param coord The world-space location.
154  * @param vec The resulting normalized vector.
155  */
156 void ED_view3d_global_to_vector(struct RegionView3D *rv3d, const float coord[3], float vec[3]);
157
158 /**
159  * Calculate the view transformation matrix from RegionView3D input.
160  * The resulting matrix is equivilent to RegionView3D.viewinv
161  * @param mat The view 4x4 transformation matrix to calculate.
162  * @param ofs The view offset, normally from RegionView3D.ofs.
163  * @param quat The view rotation, quaternion normally from RegionView3D.viewquat.
164  * @param dist The view distance from ofs, normally from RegionView3D.dist.
165  */
166 void ED_view3d_to_m4(float mat[][4], const float ofs[3], const float quat[4], const float dist);
167
168 /**
169  * Set the view transformation from a 4x4 matrix.
170  * @param mat The view 4x4 transformation matrix to assign.
171  * @param ofs The view offset, normally from RegionView3D.ofs.
172  * @param quat The view rotation, quaternion normally from RegionView3D.viewquat.
173  * @param dist The view distance from ofs, normally from RegionView3D.dist.
174  */
175 void ED_view3d_from_m4(float mat[][4], float ofs[3], float quat[4], float *dist);
176
177 /**
178  * Set the RegionView3D members from an objects transformation and optionally lens.
179  * @param ob The object to set the view to.
180  * @param ofs The view offset to be set, normally from RegionView3D.ofs.
181  * @param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat.
182  * @param dist The view distance from ofs to be set, normally from RegionView3D.dist.
183  * @param lens The view lens angle set for cameras and lamps, normally from View3D.lens.
184  */
185 void ED_view3d_from_object(struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens);
186
187 /**
188  * Set the object transformation from RegionView3D members.
189  * @param ob The object which has the transformation assigned.
190  * @param ofs The view offset, normally from RegionView3D.ofs.
191  * @param quat The view rotation, quaternion normally from RegionView3D.viewquat.
192  * @param dist The view distance from ofs, normally from RegionView3D.dist.
193  */
194 void ED_view3d_to_object(struct Object *ob, const float ofs[3], const float quat[4], const float dist);
195
196 //#if 0 /* UNUSED */
197 void view3d_unproject(struct bglMats *mats, float out[3], const short x, const short y, const float z);
198 //#endif
199
200 /* Depth buffer */
201 void ED_view3d_depth_update(struct ARegion *ar);
202 float ED_view3d_depth_read_cached(struct ViewContext *vc, int x, int y);
203 void ED_view3d_depth_tag_update(struct RegionView3D *rv3d);
204
205 /* Projection */
206 #define IS_CLIPPED        12000
207
208 void ED_view3d_calc_clipping(struct BoundBox *bb, float planes[4][4], struct bglMats *mats, const struct rcti *rect);
209
210 void project_short(struct ARegion *ar, const float vec[3], short adr[2]);
211 void project_short_noclip(struct ARegion *ar, const float vec[3], short adr[2]);
212
213 void project_int(struct ARegion *ar, const float vec[3], int adr[2]);
214 void project_int_noclip(struct ARegion *ar, const float vec[3], int adr[2]);
215
216 void apply_project_float(float persmat[4][4], int winx, int winy, const float vec[], float adr[2]);
217 void project_float(struct ARegion *ar, const float vec[3], float adr[2]);
218 void project_float_noclip(struct ARegion *ar, const float vec[3], float adr[2]);
219
220 int ED_view3d_clip_range_get(struct View3D *v3d, struct RegionView3D *rv3d, float *clipsta, float *clipend);
221 int ED_view3d_viewplane_get(struct View3D *v3d, struct RegionView3D *rv3d, int winxi, int winyi, struct rctf *viewplane, float *clipsta, float *clipend);
222 void ED_view3d_ob_project_mat_get(struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
223 void ED_view3d_project_float(const struct ARegion *a, const float vec[3], float adr[2], float mat[4][4]);
224 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);
225 void ED_view3d_project_float_v3(struct ARegion *a, float *vec, float *adr, float mat[4][4]);
226 void ED_view3d_calc_camera_border_size(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, struct RegionView3D *rv3d, float size_r[2]);
227
228 /* drawobject.c iterators */
229 void mesh_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct BMVert *eve, int x, int y, int index), void *userData, eV3DClipTest clipVerts);
230 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);
231 void mesh_foreachScreenFace(struct ViewContext *vc, void (*func)(void *userData, struct BMFace *efa, int x, int y, int index), void *userData);
232 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);
233 void lattice_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct BPoint *bp, int x, int y), void *userData);
234
235 void ED_view3d_local_clipping(struct RegionView3D *rv3d, float mat[][4]);
236 int ED_view3d_test_clipping(struct RegionView3D *rv3d, const float vec[3], const int local);
237 void ED_view3d_align_axis_to_vector(struct View3D *v3d, struct RegionView3D *rv3d, int axisidx, float vec[3]);
238 float ED_view3d_pixel_size(struct RegionView3D *rv3d, const float co[3]);
239
240 void drawcircball(int mode, const float cent[3], float rad, float tmat[][4]);
241
242 /* backbuffer select and draw support */
243 void view3d_validate_backbuf(struct ViewContext *vc);
244 struct ImBuf *view3d_read_backbuf(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
245 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,
246                                                                                 void *handle, unsigned int (*indextest)(void *handle, unsigned int index));
247 unsigned int view3d_sample_backbuf(struct ViewContext *vc, int x, int y);
248
249 /* draws and does a 4x4 sample */
250 int ED_view3d_autodist(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, const int mval[2], float mouse_worldloc[3]);
251
252 /* only draw so ED_view3d_autodist_simple can be called many times after */
253 int ED_view3d_autodist_init(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, int mode);
254 int ED_view3d_autodist_simple(struct ARegion *ar, const int mval[2], float mouse_worldloc[3], int margin, float *force_depth);
255 int ED_view3d_autodist_depth(struct ARegion *ar, const int mval[2], int margin, float *depth);
256 int ED_view3d_autodist_depth_seg(struct ARegion *ar, const int mval_sta[2], const int mval_end[2], int margin, float *depth);
257
258 /* select */
259 #define MAXPICKBUF      10000
260 short view3d_opengl_select(struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, rcti *input);
261
262 void view3d_set_viewcontext(struct bContext *C, struct ViewContext *vc);
263 void view3d_operator_needs_opengl(const struct bContext *C);
264 void view3d_region_operator_needs_opengl(struct wmWindow *win, struct ARegion *ar);
265 int view3d_get_view_aligned_coordinate(struct ViewContext *vc, float fp[3], const int mval[2], const short do_fallback);
266 void view3d_get_transformation(const struct ARegion *ar, struct RegionView3D *rv3d, struct Object *ob, struct bglMats *mats);
267
268 /* XXX should move to BLI_math */
269 int edge_inside_circle(short centx, short centy, short rad, short x1, short y1, short x2, short y2);
270 int lasso_inside(int mcords[][2], short moves, int sx, int sy);
271 int lasso_inside_edge(int mcords[][2], short moves, int x0, int y0, int x1, int y1);
272
273 /* get 3d region from context, also if mouse is in header or toolbar */
274 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
275 int ED_view3d_context_user_region(struct bContext *C, struct View3D **v3d_r, struct ARegion **ar_r);
276 int ED_operator_rv3d_user_region_poll(struct bContext *C);
277
278 void ED_view3d_init_mats_rv3d(struct Object *ob, struct RegionView3D *rv3d);
279 void ED_view3d_init_mats_rv3d_gl(struct Object *ob, struct RegionView3D *rv3d);
280
281 int ED_view3d_scene_layer_set(int lay, const int *values, int *active);
282
283 int ED_view3d_context_activate(struct bContext *C);
284 void ED_view3d_draw_offscreen(struct Scene *scene, struct View3D *v3d, struct ARegion *ar,
285         int winx, int winy, float viewmat[][4], float winmat[][4]);
286
287 struct ImBuf *ED_view3d_draw_offscreen_imbuf(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, int sizex, int sizey, unsigned int flag, char err_out[256]);
288 struct ImBuf *ED_view3d_draw_offscreen_imbuf_simple(struct Scene *scene, struct Object *camera, int width, int height, unsigned int flag, int drawtype, char err_out[256]);
289
290
291 struct Base *ED_view3d_give_base_under_cursor(struct bContext *C, const int mval[2]);
292 void ED_view3d_quadview_update(struct ScrArea *sa, struct ARegion *ar, short do_clip);
293 int ED_view3d_lock(struct RegionView3D *rv3d);
294
295 uint64_t ED_view3d_datamask(struct Scene *scene, struct View3D *v3d);
296 uint64_t ED_view3d_screen_datamask(struct bScreen *screen);
297 uint64_t ED_view3d_object_datamask(struct Scene *scene);
298
299 /* camera lock functions */
300 int ED_view3d_camera_lock_check(struct View3D *v3d, struct RegionView3D *rv3d);
301 /* copy the camera to the view before starting a view transformation */
302 void ED_view3d_camera_lock_init(struct View3D *v3d, struct RegionView3D *rv3d);
303 /* copy the view to the camera, return TRUE if */
304 int ED_view3d_camera_lock_sync(struct View3D *v3d, struct RegionView3D *rv3d);
305
306 struct BGpic *ED_view3D_background_image_new(struct View3D *v3d);
307 void ED_view3D_background_image_remove(struct View3D *v3d, struct BGpic *bgpic);
308 void ED_view3D_background_image_clear(struct View3D *v3d);
309
310 /* view matrix properties utilities */
311 void ED_view3d_operator_properties_viewmat(struct wmOperatorType *ot);
312 void ED_view3d_operator_properties_viewmat_set(struct bContext *C, struct wmOperator *op);
313 void ED_view3d_operator_properties_viewmat_get(struct wmOperator *op, int *winx, int *winy, float persmat[4][4]);
314
315 #endif /* ED_VIEW3D_H */