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