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