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