Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_view3d / view3d_intern.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_view3d/view3d_intern.h
28  *  \ingroup spview3d
29  */
30
31 #ifndef __VIEW3D_INTERN_H__
32 #define __VIEW3D_INTERN_H__
33
34 #include "ED_view3d.h"
35
36 /* internal exports only */
37
38 struct ARegion;
39 struct ARegionType;
40 struct BoundBox;
41 struct DerivedMesh;
42 struct Object;
43 struct SmokeDomainSettings;
44 struct bAnimVizSettings;
45 struct bContext;
46 struct bMotionPath;
47 struct bPoseChannel;
48 struct Mesh;
49 struct wmNDOFMotionData;
50 struct wmOperatorType;
51 struct wmWindowManager;
52 struct wmKeyConfig;
53
54 /* drawing flags: */
55 enum {
56         DRAW_PICKING     = (1 << 0),
57         DRAW_CONSTCOLOR  = (1 << 1),
58         DRAW_SCENESET    = (1 << 2)
59 };
60
61 /* draw_mesh_fancy/draw_mesh_textured draw_flags */
62 enum {
63         DRAW_MODIFIERS_PREVIEW  = (1 << 0),
64         DRAW_FACE_SELECT        = (1 << 1)
65 };
66
67 /* view3d_header.c */
68 void VIEW3D_OT_layers(struct wmOperatorType *ot);
69
70 /* view3d_ops.c */
71 void view3d_operatortypes(void);
72
73 /* view3d_edit.c */
74 void VIEW3D_OT_zoom(struct wmOperatorType *ot);
75 void VIEW3D_OT_dolly(struct wmOperatorType *ot);
76 void VIEW3D_OT_zoom_camera_1_to_1(struct wmOperatorType *ot);
77 void VIEW3D_OT_move(struct wmOperatorType *ot);
78 void VIEW3D_OT_rotate(struct wmOperatorType *ot);
79 void VIEW3D_OT_ndof_orbit(struct wmOperatorType *ot);
80 void VIEW3D_OT_ndof_orbit_zoom(struct wmOperatorType *ot);
81 void VIEW3D_OT_ndof_pan(struct wmOperatorType *ot);
82 void VIEW3D_OT_ndof_all(struct wmOperatorType *ot);
83 void VIEW3D_OT_view_all(struct wmOperatorType *ot);
84 void VIEW3D_OT_viewnumpad(struct wmOperatorType *ot);
85 void VIEW3D_OT_view_selected(struct wmOperatorType *ot);
86 void VIEW3D_OT_view_lock_clear(struct wmOperatorType *ot);
87 void VIEW3D_OT_view_lock_to_active(struct wmOperatorType *ot);
88 void VIEW3D_OT_view_center_cursor(struct wmOperatorType *ot);
89 void VIEW3D_OT_view_center_pick(struct wmOperatorType *ot);
90 void VIEW3D_OT_view_center_camera(struct wmOperatorType *ot);
91 void VIEW3D_OT_view_center_lock(struct wmOperatorType *ot);
92 void VIEW3D_OT_view_pan(struct wmOperatorType *ot);
93 void VIEW3D_OT_view_persportho(struct wmOperatorType *ot);
94 void VIEW3D_OT_navigate(struct wmOperatorType *ot);
95 void VIEW3D_OT_background_image_add(struct wmOperatorType *ot);
96 void VIEW3D_OT_background_image_remove(struct wmOperatorType *ot);
97 void VIEW3D_OT_view_orbit(struct wmOperatorType *ot);
98 void VIEW3D_OT_view_roll(struct wmOperatorType *ot);
99 void VIEW3D_OT_clip_border(struct wmOperatorType *ot);
100 void VIEW3D_OT_cursor3d(struct wmOperatorType *ot);
101 void VIEW3D_OT_manipulator(struct wmOperatorType *ot);
102 void VIEW3D_OT_enable_manipulator(struct wmOperatorType *ot);
103 void VIEW3D_OT_render_border(struct wmOperatorType *ot);
104 void VIEW3D_OT_clear_render_border(struct wmOperatorType *ot);
105 void VIEW3D_OT_zoom_border(struct wmOperatorType *ot);
106 void VIEW3D_OT_toggle_render(struct wmOperatorType *ot);
107
108 void view3d_boxview_copy(ScrArea *sa, ARegion *ar);
109
110 void view3d_orbit_apply_dyn_ofs(
111         float r_ofs[3], const float ofs_old[3], const float viewquat_old[4],
112         const float viewquat_new[4], const float dyn_ofs[3]);
113
114 void view3d_ndof_fly(
115         const struct wmNDOFMotionData *ndof,
116         struct View3D *v3d, struct RegionView3D *rv3d,
117         const bool use_precision, const short protectflag,
118         bool *r_has_translate, bool *r_has_rotate);
119
120 /* view3d_fly.c */
121 void view3d_keymap(struct wmKeyConfig *keyconf);
122 void VIEW3D_OT_fly(struct wmOperatorType *ot);
123
124 /* view3d_walk.c */
125 void VIEW3D_OT_walk(struct wmOperatorType *ot);
126
127 /* view3d_ruler.c */
128 void VIEW3D_OT_ruler(struct wmOperatorType *ot);
129
130 /* drawanim.c */
131 void draw_motion_paths_init(View3D *v3d, struct ARegion *ar);
132 void draw_motion_path_instance(Scene *scene,
133                                struct Object *ob, struct bPoseChannel *pchan,
134                                struct bAnimVizSettings *avs, struct bMotionPath *mpath);
135 void draw_motion_paths_cleanup(View3D *v3d);
136
137
138
139 /* drawobject.c */
140 void draw_object(Scene *scene, struct ARegion *ar, View3D *v3d, Base *base, const short dflag);
141 bool draw_glsl_material(Scene *scene, struct Object *ob, View3D *v3d, const char dt);
142 void draw_object_instance(Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob, const char dt, int outline);
143 void draw_object_backbufsel(Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob);
144 void drawaxes(const float viewmat_local[4][4], float size, char drawtype);
145
146 void view3d_cached_text_draw_begin(void);
147 void view3d_cached_text_draw_add(const float co[3],
148                                  const char *str, const size_t str_len,
149                                  short xoffs, short flag, const unsigned char col[4]);
150 void view3d_cached_text_draw_end(View3D *v3d, ARegion *ar, bool depth_write, float mat[4][4]);
151
152 bool check_object_draw_texture(struct Scene *scene, struct View3D *v3d, const char drawtype);
153
154 enum {
155         V3D_CACHE_TEXT_ZBUF         = (1 << 0),
156         V3D_CACHE_TEXT_WORLDSPACE   = (1 << 1),
157         V3D_CACHE_TEXT_ASCII        = (1 << 2),
158         V3D_CACHE_TEXT_GLOBALSPACE  = (1 << 3),
159         V3D_CACHE_TEXT_LOCALCLIP    = (1 << 4)
160 };
161
162 int view3d_effective_drawtype(const struct View3D *v3d);
163
164 /* drawarmature.c */
165 bool draw_armature(Scene *scene, View3D *v3d, ARegion *ar, Base *base,
166                    const short dt, const short dflag, const unsigned char ob_wire_col[4],
167                    const bool is_outline);
168
169 /* drawmesh.c */
170 void draw_mesh_textured(Scene *scene, View3D *v3d, RegionView3D *rv3d,
171                         struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
172 void draw_mesh_face_select(
173         struct RegionView3D *rv3d, struct Mesh *me, struct DerivedMesh *dm,
174         bool draw_select_edges);
175 void draw_mesh_paint_weight_faces(struct DerivedMesh *dm, const bool do_light,
176                                   void *facemask_cb, void *user_data);
177 void draw_mesh_paint_vcolor_faces(struct DerivedMesh *dm, const bool use_light,
178                                   void *facemask_cb, void *user_data,
179                                   const struct Mesh *me);
180 void draw_mesh_paint_weight_edges(RegionView3D *rv3d, struct DerivedMesh *dm,
181                                   const bool use_depth, const bool use_alpha,
182                                   void *edgemask_cb, void *user_data);
183 void draw_mesh_paint(View3D *v3d, RegionView3D *rv3d,
184                      struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
185
186 /* drawsimdebug.c */
187 void draw_sim_debug_data(Scene *scene, View3D *v3d, ARegion *ar);
188
189 /* view3d_draw.c */
190 void view3d_main_region_draw(const struct bContext *C, struct ARegion *ar);
191 void ED_view3d_draw_depth(Scene *scene, struct ARegion *ar, View3D *v3d, bool alphaoverride);
192 void ED_view3d_draw_depth_gpencil(Scene *scene, ARegion *ar, View3D *v3d);
193 void ED_view3d_after_add(ListBase *lb, Base *base, const short dflag);
194
195 void circf(float x, float y, float rad);
196 void circ(float x, float y, float rad);
197 void view3d_update_depths_rect(struct ARegion *ar, struct ViewDepths *d, struct rcti *rect);
198 float view3d_depth_near(struct ViewDepths *d);
199
200 /* view3d_select.c */
201 void VIEW3D_OT_select(struct wmOperatorType *ot);
202 void VIEW3D_OT_select_circle(struct wmOperatorType *ot);
203 void VIEW3D_OT_select_border(struct wmOperatorType *ot);
204 void VIEW3D_OT_select_lasso(struct wmOperatorType *ot);
205 void VIEW3D_OT_select_menu(struct wmOperatorType *ot);
206
207 void VIEW3D_OT_smoothview(struct wmOperatorType *ot);
208 void VIEW3D_OT_camera_to_view(struct wmOperatorType *ot);
209 void VIEW3D_OT_camera_to_view_selected(struct wmOperatorType *ot);
210 void VIEW3D_OT_object_as_camera(struct wmOperatorType *ot);
211 void VIEW3D_OT_localview(struct wmOperatorType *ot);
212 void VIEW3D_OT_game_start(struct wmOperatorType *ot);
213
214
215 bool ED_view3d_boundbox_clip_ex(const RegionView3D *rv3d, const struct BoundBox *bb, float obmat[4][4]);
216 bool ED_view3d_boundbox_clip(RegionView3D *rv3d, const struct BoundBox *bb);
217
218 typedef struct V3D_SmoothParams {
219         struct Object *camera_old, *camera;
220         const float *ofs, *quat, *dist, *lens;
221         /* alternate rotation center (ofs = must be NULL) */
222         const float *dyn_ofs;
223 } V3D_SmoothParams;
224
225 void ED_view3d_smooth_view_ex(
226         struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa,
227         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
228         const V3D_SmoothParams *sview);
229
230 void ED_view3d_smooth_view(
231         struct bContext *C,
232         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
233         const V3D_SmoothParams *sview);
234
235 void ED_view3d_smooth_view_force_finish(
236         struct bContext *C,
237         struct View3D *v3d, struct ARegion *ar);
238
239 void view3d_winmatrix_set(ARegion *ar, const View3D *v3d, const rctf *rect);
240 void view3d_viewmatrix_set(Scene *scene, const View3D *v3d, RegionView3D *rv3d);
241
242 void fly_modal_keymap(struct wmKeyConfig *keyconf);
243 void walk_modal_keymap(struct wmKeyConfig *keyconf);
244 void viewrotate_modal_keymap(struct wmKeyConfig *keyconf);
245 void viewmove_modal_keymap(struct wmKeyConfig *keyconf);
246 void viewzoom_modal_keymap(struct wmKeyConfig *keyconf);
247 void viewdolly_modal_keymap(struct wmKeyConfig *keyconf);
248
249 /* view3d_buttons.c */
250 void VIEW3D_OT_properties(struct wmOperatorType *ot);
251 void view3d_buttons_register(struct ARegionType *art);
252
253 /* view3d_camera_control.c */
254 struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
255         Scene *scene, View3D *v3d, RegionView3D *rv3d,
256         const bool use_parent_root);
257 void ED_view3d_cameracontrol_update(
258         struct View3DCameraControl *vctrl,
259         const bool use_autokey,
260         struct bContext *C, const bool do_rotate, const bool do_translate);
261 void ED_view3d_cameracontrol_release(
262         struct View3DCameraControl *vctrl,
263         const bool restore);
264 struct Object *ED_view3d_cameracontrol_object_get(
265         struct View3DCameraControl *vctrl);
266
267 /* view3d_toolbar.c */
268 void VIEW3D_OT_toolshelf(struct wmOperatorType *ot);
269 void view3d_toolshelf_register(struct ARegionType *art);
270 void view3d_tool_props_register(struct ARegionType *art);
271
272 /* view3d_snap.c */
273 bool ED_view3d_minmax_verts(struct Object *obedit, float min[3], float max[3]);
274
275 void VIEW3D_OT_snap_selected_to_grid(struct wmOperatorType *ot);
276 void VIEW3D_OT_snap_selected_to_cursor(struct wmOperatorType *ot);
277 void VIEW3D_OT_snap_cursor_to_grid(struct wmOperatorType *ot);
278 void VIEW3D_OT_snap_cursor_to_center(struct wmOperatorType *ot);
279 void VIEW3D_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
280 void VIEW3D_OT_snap_cursor_to_active(struct wmOperatorType *ot);
281
282 /* space_view3d.c */
283 ARegion *view3d_has_buttons_region(ScrArea *sa);
284 ARegion *view3d_has_tools_region(ScrArea *sa);
285
286 extern const char *view3d_context_dir[]; /* doc access */
287
288 /* draw_volume.c */
289 void draw_smoke_volume(struct SmokeDomainSettings *sds, struct Object *ob,
290                        const float min[3], const float max[3],
291                        const float viewnormal[3]);
292
293 //#define SMOKE_DEBUG_VELOCITY
294 //#define SMOKE_DEBUG_HEAT
295
296 #ifdef SMOKE_DEBUG_VELOCITY
297 void draw_smoke_velocity(struct SmokeDomainSettings *domain, struct Object *ob);
298 #endif
299 #ifdef SMOKE_DEBUG_HEAT
300 void draw_smoke_heat(struct SmokeDomainSettings *domain, struct Object *ob);
301 #endif
302
303 /* workaround for trivial but noticeable camera bug caused by imprecision
304  * between view border calculation in 2D/3D space, workaround for bug [#28037].
305  * without this define we get the old behavior which is to try and align them
306  * both which _mostly_ works fine, but when the camera moves beyond ~1000 in
307  * any direction it starts to fail */
308 #define VIEW3D_CAMERA_BORDER_HACK
309 #ifdef VIEW3D_CAMERA_BORDER_HACK
310 extern unsigned char view3d_camera_border_hack_col[3];
311 extern bool view3d_camera_border_hack_test;
312 #endif
313
314 #endif /* __VIEW3D_INTERN_H__ */
315