985130bb97ff2b8f91f5d87fc192185b191a05df
[blender.git] / source / blender / editors / include / ED_view3d.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ED_view3d.h
30  *  \ingroup editors
31  */
32
33 #ifndef ED_VIEW3D_H
34 #define ED_VIEW3D_H
35
36 /* ********* exports for space_view3d/ module ********** */
37 struct ARegion;
38 struct bContext;
39 struct BezTriple;
40 struct bglMats;
41 struct BoundBox;
42 struct BPoint;
43 struct EditEdge;
44 struct EditFace;
45 struct EditVert;
46 struct ImBuf;
47 struct Main;
48 struct Nurb;
49 struct Object;
50 struct rcti;
51 struct RegionView3D;
52 struct Scene;
53 struct View3D;
54 struct ViewContext;
55 struct wmWindow;
56 struct MVert;
57
58
59 /* for derivedmesh drawing callbacks, for view3d_select, .... */
60 typedef struct ViewContext {
61         struct Scene *scene;
62         struct Object *obact;
63         struct Object *obedit;
64         struct ARegion *ar;
65         struct View3D *v3d;
66         struct RegionView3D *rv3d;
67         struct EditMesh *em;
68         int mval[2];
69 } ViewContext;
70
71 typedef struct ViewDepths {
72         unsigned short w, h;
73         short x, y; /* only for temp use for sub-rects, added to ar->winx/y */
74         float *depths;
75         double depth_range[2];
76         
77         char damaged;
78 } ViewDepths;
79
80
81 float *give_cursor(struct Scene *scene, struct View3D *v3d);
82
83 int initgrabz(struct RegionView3D *rv3d, float x, float y, float z);
84
85 /**
86  * Calculate a 3d location from 2d window coordinates.
87  * @param ar The region (used for the window width and height).
88  * @param depth_pt The reference location used to calculate the Z depth.
89  * @param mval The area relative location (such as event->mval converted to floats).
90  * @param out The resulting world-space location.
91  */
92 void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const float mval[2], float out[3]);
93
94 /**
95  * Calculate a 3d difference vector from 2d window offset.
96  * note that initgrabz() must be called first to determine
97  * the depth used to calculate the delta.
98  * @param ar The region (used for the window width and height).
99  * @param mval The area relative 2d difference (such as event->mval[0] - other_x).
100  * @param out The resulting world-space delta.
101  */
102 void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3]);
103
104 /**
105  * Calculate a 3d direction vector from 2d window coordinates.
106  * This direction vector starts and the view in the direction of the 2d window coordinates.
107  * In orthographic view all window coordinates yield the same vector.
108  * @param ar The region (used for the window width and height).
109  * @param mval The area relative 2d location (such as event->mval converted to floats).
110  * @param out The resulting normalized world-space direction vector.
111  */
112 void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[3]);
113
114 /**
115  * Calculate a 3d segment from 2d window coordinates.
116  * This ray_start is located at the viewpoint, ray_end is a far point.
117  * ray_start and ray_end are clipped by the view near and far limits
118  * so points along this line are always in view.
119  * In orthographic view all resulting segments will be parallel.
120  * @param ar The region (used for the window width and height).
121  * @param v3d The 3d viewport (used for near and far clipping range).
122  * @param mval The area relative 2d location (such as event->mval, converted into float[2]).
123  * @param ray_start The world-space starting point of the segment.
124  * @param ray_end The world-space end point of the segment.
125  */
126 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]);
127
128 /**
129  * Calculate a 3d viewpoint and direction vector from 2d window coordinates.
130  * This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
131  * ray_start is clipped by the view near limit so points in front of it are always in view.
132  * In orthographic view the resulting ray_normal will match the view vector.
133  * @param ar The region (used for the window width and height).
134  * @param v3d The 3d viewport (used for near clipping value).
135  * @param out The resulting normalized world-space direction vector.
136  * @param mval The area relative 2d location (such as event->mval, converted into float[2]).
137  * @param ray_start The world-space starting point of the segment.
138  * @param ray_normal The normalized world-space direction of towards mval.
139  */
140 void ED_view3d_win_to_ray(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_normal[3]);
141
142 /**
143  * Calculate a normalized 3d direction vector from the viewpoint towards a global location.
144  * In orthographic view the resulting vector will match the view vector.
145  * @param ar The region (used for the window width and height).
146  * @param coord The world-space location.
147  * @param vec The resulting normalized vector.
148  */
149 void ED_view3d_global_to_vector(struct RegionView3D *rv3d, const float coord[3], float vec[3]);
150
151 /**
152  * Calculate the view transformation matrix from RegionView3D input.
153  * The resulting matrix is equivilent to RegionView3D.viewinv
154  * @param mat The view 4x4 transformation matrix to calculate.
155  * @param ofs The view offset, normally from RegionView3D.ofs.
156  * @param quat The view rotation, quaternion normally from RegionView3D.viewquat.
157  * @param dist The view distance from ofs, normally from RegionView3D.dist.
158  */
159 void ED_view3d_to_m4(float mat[][4], const float ofs[3], const float quat[4], const float dist);
160
161 /**
162  * Set the view transformation from a 4x4 matrix.
163  * @param mat The view 4x4 transformation matrix to assign.
164  * @param ofs The view offset, normally from RegionView3D.ofs.
165  * @param quat The view rotation, quaternion normally from RegionView3D.viewquat.
166  * @param dist The view distance from ofs, normally from RegionView3D.dist.
167  */
168 void ED_view3d_from_m4(float mat[][4], float ofs[3], float quat[4], float *dist);
169
170 /**
171  * Set the RegionView3D members from an objects transformation and optionally lens.
172  * @param ob The object to set the view to.
173  * @param ofs The view offset to be set, normally from RegionView3D.ofs.
174  * @param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat.
175  * @param dist The view distance from ofs to be set, normally from RegionView3D.dist.
176  */
177 void ED_view3d_from_object(struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens);
178
179 /**
180  * Set the object transformation from RegionView3D members.
181  * @param ob The object which has the transformation assigned.
182  * @param ofs The view offset, normally from RegionView3D.ofs.
183  * @param quat The view rotation, quaternion normally from RegionView3D.viewquat.
184  * @param dist The view distance from ofs, normally from RegionView3D.dist.
185  */
186 void ED_view3d_to_object(struct Object *ob, const float ofs[3], const float quat[4], const float dist);
187
188 #if 0 /* UNUSED */
189 void view3d_unproject(struct bglMats *mats, float out[3], const short x, const short y, const float z);
190 #endif
191
192 /* Depth buffer */
193 void ED_view3d_depth_update(struct ARegion *ar);
194 float ED_view3d_depth_read_cached(struct ViewContext *vc, int x, int y);
195 void ED_view3d_depth_tag_update(struct RegionView3D *rv3d);
196
197 /* Projection */
198 #define IS_CLIPPED        12000
199
200 void ED_view3d_calc_clipping(struct BoundBox *bb, float planes[4][4], struct bglMats *mats, struct rcti *rect);
201
202 void project_short(struct ARegion *ar, const float vec[3], short adr[2]);
203 void project_short_noclip(struct ARegion *ar, const float vec[3], short adr[2]);
204
205 void project_int(struct ARegion *ar, const float vec[3], int adr[2]);
206 void project_int_noclip(struct ARegion *ar, const float vec[3], int adr[2]);
207
208 void project_float(struct ARegion *ar, const float vec[3], float adr[2]);
209 void project_float_noclip(struct ARegion *ar, const float vec[3], float adr[2]);
210
211 void ED_view3d_ob_clip_range_get(struct Object *ob, float *lens, float *clipsta, float *clipend);
212 int ED_view3d_clip_range_get(struct View3D *v3d, struct RegionView3D *rv3d, float *clipsta, float *clipend);
213 int ED_view3d_viewplane_get(struct View3D *v3d, struct RegionView3D *rv3d, int winxi, int winyi, struct rctf *viewplane, float *clipsta, float *clipend, float *pixsize);
214 void ED_view3d_ob_project_mat_get(struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
215 void ED_view3d_project_float(struct ARegion *a, const float vec[3], float adr[2], float mat[4][4]);
216 void ED_view3d_calc_camera_border(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, struct RegionView3D *rv3d, struct rctf *viewborder_r, short do_shift);
217
218 /* drawobject.c iterators */
219 /* Radish */
220 void mesh_obmode_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct MVert *mv, int x, int y, int index), void *userData, int clipVerts);
221
222 void mesh_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct EditVert *eve, int x, int y, int index), void *userData, int clipVerts);
223 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, int clipVerts);
224 void mesh_foreachScreenFace(struct ViewContext *vc, void (*func)(void *userData, struct EditFace *efa, int x, int y, int index), void *userData);
225 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);
226 void lattice_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct BPoint *bp, int x, int y), void *userData);
227
228 void ED_view3d_local_clipping(struct RegionView3D *rv3d, float mat[][4]);
229 int ED_view3d_test_clipping(struct RegionView3D *rv3d, const float vec[3], const int local);
230 void ED_view3d_align_axis_to_vector(struct View3D *v3d, struct RegionView3D *rv3d, int axisidx, float vec[3]);
231 float ED_view3d_pixel_size(struct RegionView3D *rv3d, const float co[3]);
232
233 void drawcircball(int mode, const float cent[3], float rad, float tmat[][4]);
234
235 /* backbuffer select and draw support */
236 void view3d_validate_backbuf(struct ViewContext *vc);
237 struct ImBuf *view3d_read_backbuf(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
238 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,
239                                                                                 void *handle, unsigned int (*indextest)(void *handle, unsigned int index));
240 unsigned int view3d_sample_backbuf(struct ViewContext *vc, int x, int y);
241
242 /* draws and does a 4x4 sample */
243 int ED_view3d_autodist(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, const int mval[2], float mouse_worldloc[3]);
244
245 /* only draw so ED_view3d_autodist_simple can be called many times after */
246 int ED_view3d_autodist_init(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, int mode);
247 int ED_view3d_autodist_simple(struct ARegion *ar, const int mval[2], float mouse_worldloc[3], int margin, float *force_depth);
248 int ED_view3d_autodist_depth(struct ARegion *ar, const int mval[2], int margin, float *depth);
249 int ED_view3d_autodist_depth_seg(struct ARegion *ar, const int mval_sta[2], const int mval_end[2], int margin, float *depth);
250
251 /* select */
252 #define MAXPICKBUF      10000
253 short view3d_opengl_select(struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, rcti *input);
254
255 void view3d_set_viewcontext(struct bContext *C, struct ViewContext *vc);
256 void view3d_operator_needs_opengl(const struct bContext *C);
257 void view3d_region_operator_needs_opengl(struct wmWindow *win, struct ARegion *ar);
258 int view3d_get_view_aligned_coordinate(struct ViewContext *vc, float fp[3], const int mval[2], const short do_fallback);
259 void view3d_get_transformation(struct ARegion *ar, struct RegionView3D *rv3d, struct Object *ob, struct bglMats *mats);
260
261 /* XXX should move to BLI_math */
262 int edge_inside_circle(short centx, short centy, short rad, short x1, short y1, short x2, short y2);
263 int lasso_inside(int mcords[][2], short moves, int sx, int sy);
264 int lasso_inside_edge(int mcords[][2], short moves, int x0, int y0, int x1, int y1);
265
266 /* get 3d region from context, also if mouse is in header or toolbar */
267 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
268 struct ARegion *ED_view3d_context_region_unlock(struct bContext *C);
269 int ED_operator_rv3d_unlock_poll(struct bContext *C);
270
271 void ED_view3d_init_mats_rv3d(struct Object *ob, struct RegionView3D *rv3d);
272 void ED_view3d_init_mats_rv3d_gl(struct Object *ob, struct RegionView3D *rv3d);
273
274 int ED_view3d_scene_layer_set(int lay, const int *values, int *active);
275
276 int ED_view3d_context_activate(struct bContext *C);
277 void ED_view3d_draw_offscreen(struct Scene *scene, struct View3D *v3d, struct ARegion *ar,
278         int winx, int winy, float viewmat[][4], float winmat[][4]);
279
280 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]);
281 struct ImBuf *ED_view3d_draw_offscreen_imbuf_simple(Scene *scene, struct Object *camera, int width, int height, unsigned int flag, int drawtype, char err_out[256]);
282
283
284 Base *ED_view3d_give_base_under_cursor(struct bContext *C, const int mval[2]);
285 void ED_view3d_quadview_update(struct ScrArea *sa, struct ARegion *ar, short do_clip);
286 int ED_view3d_lock(struct RegionView3D *rv3d);
287
288 unsigned int ED_view3d_datamask(struct Scene *scene, struct View3D *v3d);
289 unsigned int ED_viewedit_datamask(struct bScreen *screen);
290
291 /* camera lock functions */
292 int ED_view3d_camera_lock_check(struct View3D *v3d, struct RegionView3D *rv3d);
293 /* copy the camera to the view before starting a view transformation */
294 void ED_view3d_camera_lock_init(struct View3D *v3d, struct RegionView3D *rv3d);
295 /* copy the view to the camera, return TRUE if */
296 int ED_view3d_camera_lock_sync(struct View3D *v3d, struct RegionView3D *rv3d);
297
298 #endif /* ED_VIEW3D_H */