4afe2ff10a2aceb86ce2dd8f5ce73befe40b5715
[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 #ifndef ED_VIEW3D_H
29 #define ED_VIEW3D_H
30
31 /* ********* exports for space_view3d/ module ********** */
32 struct ARegion;
33 struct bContext;
34 struct BezTriple;
35 struct bglMats;
36 struct BoundBox;
37 struct BPoint;
38 struct EditEdge;
39 struct EditFace;
40 struct EditVert;
41 struct ImBuf;
42 struct Main;
43 struct Nurb;
44 struct Object;
45 struct rcti;
46 struct RegionView3D;
47 struct Scene;
48 struct View3D;
49 struct ViewContext;
50 struct wmWindow;
51
52
53 /* for derivedmesh drawing callbacks, for view3d_select, .... */
54 typedef struct ViewContext {
55         struct Scene *scene;
56         struct Object *obact;
57         struct Object *obedit;
58         struct ARegion *ar;
59         struct View3D *v3d;
60         struct RegionView3D *rv3d;
61         struct EditMesh *em;
62         short mval[2];
63 } ViewContext;
64
65 typedef struct ViewDepths {
66         unsigned short w, h;
67         short x, y; /* only for temp use for sub-rects, added to ar->winx/y */
68         float *depths;
69         double depth_range[2];
70         
71         char damaged;
72 } ViewDepths;
73
74
75 float *give_cursor(struct Scene *scene, struct View3D *v3d);
76
77 int initgrabz(struct RegionView3D *rv3d, float x, float y, float z);
78 void window_to_3d(struct ARegion *ar, float *vec, short mx, short my);
79 void window_to_3d_delta(struct ARegion *ar, float *vec, short mx, short my);
80 void view3d_unproject(struct bglMats *mats, float out[3], const short x, const short y, const float z);
81
82 /* Depth buffer */
83 void view3d_update_depths(struct ARegion *ar);
84 float read_cached_depth(struct ViewContext *vc, int x, int y);
85 void request_depth_update(struct RegionView3D *rv3d);
86
87 /* Projection */
88 #define IS_CLIPPED        12000
89
90 void view3d_calculate_clipping(struct BoundBox *bb, float planes[4][4], struct bglMats *mats, struct rcti *rect);
91
92 void project_short(struct ARegion *ar, float *vec, short *adr);
93 void project_short_noclip(struct ARegion *ar, float *vec, short *adr);
94
95 void project_int(struct ARegion *ar, float *vec, int *adr);
96 void project_int_noclip(struct ARegion *ar, float *vec, int *adr);
97
98 void project_float(struct ARegion *ar, float *vec, float *adr);
99 void project_float_noclip(struct ARegion *ar, float *vec, float *adr);
100
101 void viewvector(struct RegionView3D *rv3d, float coord[3], float vec[3]);
102
103 void viewline(struct ARegion *ar, struct View3D *v3d, float mval[2], float ray_start[3], float ray_end[3]);
104 void viewray(struct ARegion *ar, struct View3D *v3d, float mval[2], float ray_start[3], float ray_normal[3]);
105
106 int get_view3d_cliprange(struct View3D *v3d, struct RegionView3D *rv3d, float *clipsta, float *clipend);
107 int get_view3d_viewplane(struct View3D *v3d, struct RegionView3D *rv3d, int winxi, int winyi, struct rctf *viewplane, float *clipsta, float *clipend, float *pixsize);
108 int get_view3d_ortho(struct View3D *v3d, struct RegionView3D *rv3d);
109 void view3d_get_object_project_mat(struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
110 void view3d_project_float(struct ARegion *a, float *vec, float *adr, float mat[4][4]);
111 void view3d_calc_camera_border(struct Scene *scene, struct ARegion *ar, struct RegionView3D *rv3d, struct View3D *v3d, struct rctf *viewborder_r, short do_shift);
112
113 /* drawobject.c iterators */
114 void mesh_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct EditVert *eve, int x, int y, int index), void *userData, int clipVerts);
115 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);
116 void mesh_foreachScreenFace(struct ViewContext *vc, void (*func)(void *userData, struct EditFace *efa, int x, int y, int index), void *userData);
117 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);
118 void lattice_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct BPoint *bp, int x, int y), void *userData);
119
120 void ED_view3d_local_clipping(struct RegionView3D *rv3d, float mat[][4]);
121 int view3d_test_clipping(struct RegionView3D *rv3d, float *vec, int local);
122 void view3d_align_axis_to_vector(struct View3D *v3d, struct RegionView3D *rv3d, int axisidx, float vec[3]);
123 float view3d_pixel_size(struct RegionView3D *rv3d, const float co[3]);
124
125 void drawcircball(int mode, const float cent[3], float rad, float tmat[][4]);
126
127 /* backbuffer select and draw support */
128 void view3d_validate_backbuf(struct ViewContext *vc);
129 struct ImBuf *view3d_read_backbuf(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
130 unsigned int view3d_sample_backbuf_rect(struct ViewContext *vc, short mval[2], int size, unsigned int min, unsigned int max, int *dist, short strict, 
131                                                                                 void *handle, unsigned int (*indextest)(void *handle, unsigned int index));
132 unsigned int view3d_sample_backbuf(struct ViewContext *vc, int x, int y);
133
134 /* draws and does a 4x4 sample */
135 int view_autodist(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, short *mval, float mouse_worldloc[3]);
136
137 /* only draw so view_autodist_simple can be called many times after */
138 int view_autodist_init(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, int mode);
139 int view_autodist_simple(struct ARegion *ar, short mval[2], float mouse_worldloc[3], int margin, float *force_depth);
140 int view_autodist_depth(struct ARegion *ar, short mval[2], int margin, float *depth);
141 int view_autodist_depth_segment(struct ARegion *ar, short mval_sta[2], short mval_end[2], int margin, float *depth);
142
143 /* select */
144 #define MAXPICKBUF      10000
145 short view3d_opengl_select(struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, rcti *input);
146
147 void view3d_set_viewcontext(struct bContext *C, struct ViewContext *vc);
148 void view3d_operator_needs_opengl(const struct bContext *C);
149 void view3d_region_operator_needs_opengl(struct wmWindow *win, struct ARegion *ar);
150 void view3d_get_view_aligned_coordinate(struct ViewContext *vc, float *fp, short mval[2]);
151 void view3d_get_transformation(struct ARegion *ar, struct RegionView3D *rv3d, struct Object *ob, struct bglMats *mats);
152
153 /* XXX should move to arithb.c */
154 int edge_inside_circle(short centx, short centy, short rad, short x1, short y1, short x2, short y2);
155 int lasso_inside(short mcords[][2], short moves, short sx, short sy);
156 int lasso_inside_edge(short mcords[][2], short moves, int x0, int y0, int x1, int y1);
157
158 /* get 3d region from context, also if mouse is in header or toolbar */
159 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
160
161 void ED_view3d_init_mats_rv3d(struct Object *ob, struct RegionView3D *rv3d);
162
163 int ED_view3d_scene_layer_set(int lay, const int *values, int *active);
164
165 int ED_view3d_context_activate(struct bContext *C);
166 void ED_view3d_draw_offscreen(struct Scene *scene, struct View3D *v3d, struct ARegion *ar,
167         int winx, int winy, float viewmat[][4], float winmat[][4]);
168
169 struct ImBuf *ED_view3d_draw_offscreen_imbuf(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, int sizex, int sizey, unsigned int flag);
170 struct ImBuf *ED_view3d_draw_offscreen_imbuf_simple(Scene *scene, int width, int height, unsigned int flag, int drawtype);
171
172
173 Base *ED_view3d_give_base_under_cursor(struct bContext *C, short *mval);
174 void ED_view3d_quadview_update(struct ScrArea *sa, struct ARegion *ar, short do_clip);
175
176 unsigned int ED_viewedit_datamask(struct bScreen *screen);
177
178 #endif /* ED_VIEW3D_H */
179