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