copying 2.5 over to trunk
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 View3D;
34 struct RegionView3D;
35 struct ViewContext;
36 struct bglMats;
37 struct BPoint;
38 struct Nurb;
39 struct BezTriple;
40 struct EditVert;
41 struct EditEdge;
42 struct EditFace;
43 struct ImBuf;
44 struct Scene;
45 struct bContext;
46
47 /* for derivedmesh drawing callbacks, for view3d_select, .... */
48 typedef struct ViewContext {
49         Scene *scene;
50         Object *obact;
51         Object *obedit;
52         struct ARegion *ar;
53         struct View3D *v3d;
54         struct RegionView3D *rv3d;
55         struct EditMesh *em;
56         short mval[2];
57 } ViewContext;
58
59 typedef struct ViewDepths {
60         unsigned short w, h;
61         float *depths;
62         double depth_range[2];
63         
64         char damaged;
65 } ViewDepths;
66
67
68 float *give_cursor(struct Scene *scene, struct View3D *v3d);
69
70 void initgrabz(struct RegionView3D *rv3d, float x, float y, float z);
71 void window_to_3d(struct ARegion *ar, float *vec, short mx, short my);
72 void window_to_3d_delta(struct ARegion *ar, float *vec, short mx, short my);
73 void view3d_unproject(struct bglMats *mats, float out[3], const short x, const short y, const float z);
74
75 /* Depth buffer */
76 float read_cached_depth(struct ViewContext *vc, int x, int y);
77 void request_depth_update(struct RegionView3D *rv3d);
78
79 /* Projection */
80 #define IS_CLIPPED        12000
81
82 void project_short(struct ARegion *ar, float *vec, short *adr);
83 void project_short_noclip(struct ARegion *ar, float *vec, short *adr);
84
85 void project_int(struct ARegion *ar, float *vec, int *adr);
86 void project_int_noclip(struct ARegion *ar, float *vec, int *adr);
87
88 void project_float(struct ARegion *ar, float *vec, float *adr);
89 void project_float_noclip(struct ARegion *ar, float *vec, float *adr);
90
91 void viewline(struct ARegion *ar, struct View3D *v3d, short mval[2], float ray_start[3], float ray_end[3]);
92 void viewray(struct ARegion *ar, struct View3D *v3d, short mval[2], float ray_start[3], float ray_normal[3]);
93
94 int get_view3d_viewplane(struct View3D *v3d, struct RegionView3D *rv3d, int winxi, int winyi, rctf *viewplane, float *clipsta, float *clipend, float *pixsize);
95 int get_view3d_ortho(struct View3D *v3d, struct RegionView3D *rv3d);
96 void view3d_get_object_project_mat(struct RegionView3D *v3d, struct Object *ob, float pmat[4][4]);
97 void view3d_project_float(struct ARegion *a, float *vec, float *adr, float mat[4][4]);
98
99 /* drawobject.c itterators */
100 void mesh_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct EditVert *eve, int x, int y, int index), void *userData, int clipVerts);
101 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);
102 void mesh_foreachScreenFace(struct ViewContext *vc, void (*func)(void *userData, struct EditFace *efa, int x, int y, int index), void *userData);
103 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);
104 void lattice_foreachScreenVert(struct ViewContext *vc, void (*func)(void *userData, struct BPoint *bp, int x, int y), void *userData);
105
106 int view3d_test_clipping(struct RegionView3D *rv3d, float *vec);
107 void view3d_align_axis_to_vector(struct View3D *v3d, struct RegionView3D *rv3d, int axisidx, float vec[3]);
108
109 void drawcircball(int mode, float *cent, float rad, float tmat[][4]);
110
111 /* backbuffer select and draw support */
112 void view3d_validate_backbuf(struct ViewContext *vc);
113 struct ImBuf *view3d_read_backbuf(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
114 unsigned int view3d_sample_backbuf_rect(struct ViewContext *vc, short mval[2], int size, unsigned int min, unsigned int max, int *dist, short strict, 
115                                                                                 void *handle, unsigned int (*indextest)(void *handle, unsigned int index));
116 unsigned int view3d_sample_backbuf(struct ViewContext *vc, int x, int y);
117
118 int view_autodist(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, short *mval, float mouse_worldloc[3]);
119
120 /* select */
121 #define MAXPICKBUF      10000
122 short view3d_opengl_select(struct ViewContext *vc, unsigned int *buffer, unsigned int bufsize, rcti *input);
123
124 void view3d_set_viewcontext(struct bContext *C, struct ViewContext *vc);
125 void view3d_operator_needs_opengl(const struct bContext *C);
126 void view3d_get_view_aligned_coordinate(struct ViewContext *vc, float *fp, short mval[2]);
127 void view3d_get_transformation(struct ViewContext *vc, struct Object *ob, struct bglMats *mats);
128
129 /* XXX should move to arithb.c */
130 int edge_inside_circle(short centx, short centy, short rad, short x1, short y1, short x2, short y2);
131 int lasso_inside(short mcords[][2], short moves, short sx, short sy);
132 int lasso_inside_edge(short mcords[][2], short moves, int x0, int y0, int x1, int y1);
133
134 /* get 3d region from context, also if mouse is in header or toolbar */
135 struct RegionView3D *ED_view3d_context_rv3d(struct bContext *C);
136
137 #endif /* ED_VIEW3D_H */
138