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 Base;
41 struct BoundBox;
42 struct Gwn_Batch;
43 struct DerivedMesh;
44 struct Object;
45 struct SmokeDomainSettings;
46 struct bAnimVizSettings;
47 struct bContext;
48 struct bMotionPath;
49 struct bPoseChannel;
50 struct Mesh;
51 struct ViewLayer;
52 struct wmOperatorType;
53 struct wmKeyConfig;
54 struct wmManipulatorGroupType;
55 struct wmManipulatorType;
56 struct wmWindowManager;
57
58 /* drawing flags: */
59 enum {
60         DRAW_PICKING     = (1 << 0),
61         DRAW_CONSTCOLOR  = (1 << 1),
62         DRAW_SCENESET    = (1 << 2)
63 };
64
65 /* draw_mesh_fancy/draw_mesh_textured draw_flags */
66 enum {
67         DRAW_MODIFIERS_PREVIEW  = (1 << 0),
68         DRAW_FACE_SELECT        = (1 << 1)
69 };
70
71 /* view3d_header.c */
72 void VIEW3D_OT_layers(struct wmOperatorType *ot);
73
74 /* view3d_ops.c */
75 void view3d_operatortypes(void);
76
77 /* view3d_edit.c */
78 void VIEW3D_OT_zoom(struct wmOperatorType *ot);
79 void VIEW3D_OT_dolly(struct wmOperatorType *ot);
80 void VIEW3D_OT_zoom_camera_1_to_1(struct wmOperatorType *ot);
81 void VIEW3D_OT_move(struct wmOperatorType *ot);
82 void VIEW3D_OT_rotate(struct wmOperatorType *ot);
83 #ifdef WITH_INPUT_NDOF
84 void VIEW3D_OT_ndof_orbit(struct wmOperatorType *ot);
85 void VIEW3D_OT_ndof_orbit_zoom(struct wmOperatorType *ot);
86 void VIEW3D_OT_ndof_pan(struct wmOperatorType *ot);
87 void VIEW3D_OT_ndof_all(struct wmOperatorType *ot);
88 #endif /* WITH_INPUT_NDOF */
89 void VIEW3D_OT_view_all(struct wmOperatorType *ot);
90 void VIEW3D_OT_viewnumpad(struct wmOperatorType *ot);
91 void VIEW3D_OT_view_selected(struct wmOperatorType *ot);
92 void VIEW3D_OT_view_lock_clear(struct wmOperatorType *ot);
93 void VIEW3D_OT_view_lock_to_active(struct wmOperatorType *ot);
94 void VIEW3D_OT_view_center_cursor(struct wmOperatorType *ot);
95 void VIEW3D_OT_view_center_pick(struct wmOperatorType *ot);
96 void VIEW3D_OT_view_center_camera(struct wmOperatorType *ot);
97 void VIEW3D_OT_view_center_lock(struct wmOperatorType *ot);
98 void VIEW3D_OT_view_pan(struct wmOperatorType *ot);
99 void VIEW3D_OT_view_persportho(struct wmOperatorType *ot);
100 void VIEW3D_OT_navigate(struct wmOperatorType *ot);
101 void VIEW3D_OT_background_image_add(struct wmOperatorType *ot);
102 void VIEW3D_OT_background_image_remove(struct wmOperatorType *ot);
103 void VIEW3D_OT_view_orbit(struct wmOperatorType *ot);
104 void VIEW3D_OT_view_roll(struct wmOperatorType *ot);
105 void VIEW3D_OT_clip_border(struct wmOperatorType *ot);
106 void VIEW3D_OT_cursor3d(struct wmOperatorType *ot);
107 void VIEW3D_OT_enable_manipulator(struct wmOperatorType *ot);
108 void VIEW3D_OT_render_border(struct wmOperatorType *ot);
109 void VIEW3D_OT_clear_render_border(struct wmOperatorType *ot);
110 void VIEW3D_OT_zoom_border(struct wmOperatorType *ot);
111 void VIEW3D_OT_toggle_render(struct wmOperatorType *ot);
112
113 void view3d_boxview_copy(ScrArea *sa, ARegion *ar);
114 void view3d_boxview_sync(ScrArea *sa, ARegion *ar);
115
116 void view3d_orbit_apply_dyn_ofs(
117         float r_ofs[3], const float ofs_old[3], const float viewquat_old[4],
118         const float viewquat_new[4], const float dyn_ofs[3]);
119
120 #ifdef WITH_INPUT_NDOF
121 struct wmNDOFMotionData;
122
123 void view3d_ndof_fly(
124         const struct wmNDOFMotionData *ndof,
125         struct View3D *v3d, struct RegionView3D *rv3d,
126         const bool use_precision, const short protectflag,
127         bool *r_has_translate, bool *r_has_rotate);
128 #endif /* WITH_INPUT_NDOF */
129
130 /* view3d_fly.c */
131 void view3d_keymap(struct wmKeyConfig *keyconf);
132 void VIEW3D_OT_fly(struct wmOperatorType *ot);
133
134 /* view3d_walk.c */
135 void VIEW3D_OT_walk(struct wmOperatorType *ot);
136
137 /* view3d_ruler.c */
138 void VIEW3D_OT_ruler(struct wmOperatorType *ot);
139
140 /* drawanim.c */
141 void draw_motion_paths_init(View3D *v3d, struct ARegion *ar);
142 void draw_motion_path_instance(Scene *scene,
143                                struct Object *ob, struct bPoseChannel *pchan,
144                                struct bAnimVizSettings *avs, struct bMotionPath *mpath);
145 void draw_motion_paths_cleanup(View3D *v3d);
146
147
148
149 /* drawobject.c */
150 void draw_object(
151         const struct EvaluationContext *eval_ctx, Scene *scene, struct ViewLayer *view_layer, struct ARegion *ar, View3D *v3d,
152         struct Base *base, const short dflag);
153 void draw_object_select(
154         const struct EvaluationContext *eval_ctx, Scene *scene, struct ViewLayer *view_layer, struct ARegion *ar, View3D *v3d,
155         Base *base, const short dflag);
156
157 void draw_mesh_object_outline(View3D *v3d, struct Object *ob, struct DerivedMesh *dm, const unsigned char ob_wire_col[4]);
158
159 bool draw_glsl_material(Scene *scene, struct ViewLayer *view_layer, struct Object *ob, View3D *v3d, const char dt);
160 void draw_object_instance(const struct EvaluationContext *eval_ctx, Scene *scene, struct ViewLayer *view_layer, View3D *v3d, RegionView3D *rv3d, struct Object *ob, const char dt, int outline, const float wire_col[4]);
161 void draw_object_backbufsel(const struct EvaluationContext *eval_ctx, Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob);
162
163 void draw_object_wire_color(Scene *scene, struct ViewLayer *, Base *base, unsigned char r_ob_wire_col[4]);
164 void drawaxes(const float viewmat_local[4][4], float size, char drawtype, const unsigned char color[4]);
165 void drawlamp(View3D *v3d, RegionView3D *rv3d, Base *base,
166               const char dt, const short dflag, const unsigned char ob_wire_col[4],
167               const bool is_obact);
168 void drawcamera(Scene *scene, View3D *v3d, RegionView3D *rv3d, Base *base,
169                 const short dflag, const unsigned char ob_wire_col[4]);
170 void drawspeaker(const unsigned char ob_wire_col[3]);
171 void draw_bounding_volume(struct Object *ob, char type, const unsigned char ob_wire_col[4]);
172 void draw_rigidbody_shape(struct Object *ob, const unsigned char ob_wire_col[4]);
173
174 void view3d_cached_text_draw_begin(void);
175 void view3d_cached_text_draw_add(const float co[3],
176                                  const char *str, const size_t str_len,
177                                  short xoffs, short flag, const unsigned char col[4]);
178 void view3d_cached_text_draw_end(View3D *v3d, ARegion *ar, bool depth_write);
179
180 bool check_object_draw_texture(struct Scene *scene, struct View3D *v3d, const char drawtype);
181
182 enum {
183         V3D_CACHE_TEXT_ZBUF         = (1 << 0),
184         V3D_CACHE_TEXT_WORLDSPACE   = (1 << 1),
185         V3D_CACHE_TEXT_ASCII        = (1 << 2),
186         V3D_CACHE_TEXT_GLOBALSPACE  = (1 << 3),
187         V3D_CACHE_TEXT_LOCALCLIP    = (1 << 4)
188 };
189
190 int view3d_effective_drawtype(const struct View3D *v3d);
191
192 /* drawarmature.c */
193 bool draw_armature(
194         const struct EvaluationContext *eval_ctx, Scene *scene, struct ViewLayer *view_layer, View3D *v3d, ARegion *ar, Base *base,
195         const short dt, const short dflag, const unsigned char ob_wire_col[4],
196         const bool is_outline);
197
198 /* drawmesh.c */
199 void draw_mesh_textured(Scene *scene, struct ViewLayer *view_layer, View3D *v3d, RegionView3D *rv3d,
200                         struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
201 void draw_mesh_face_select(
202         struct RegionView3D *rv3d, struct Mesh *me, struct DerivedMesh *dm,
203         bool draw_select_edges);
204 void draw_mesh_paint_weight_faces(struct DerivedMesh *dm, const bool do_light,
205                                   void *facemask_cb, void *user_data);
206 void draw_mesh_paint_vcolor_faces(struct DerivedMesh *dm, const bool use_light,
207                                   void *facemask_cb, void *user_data,
208                                   const struct Mesh *me);
209 void draw_mesh_paint_weight_edges(RegionView3D *rv3d, struct DerivedMesh *dm,
210                                   const bool use_depth, const bool use_alpha,
211                                   void *edgemask_cb, void *user_data);
212 void draw_mesh_paint(View3D *v3d, RegionView3D *rv3d,
213                      struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
214
215 /* drawsimdebug.c */
216 void draw_sim_debug_data(Scene *scene, View3D *v3d, ARegion *ar);
217
218 /* view3d_draw.c */
219 void view3d_main_region_draw(const struct bContext *C, struct ARegion *ar);
220 void view3d_draw_region_info(const struct bContext *C, struct ARegion *ar, const int offset);
221
222 void ED_view3d_draw_depth(
223         const struct EvaluationContext *eval_ctx, struct Depsgraph *graph,
224         struct ARegion *ar, View3D *v3d, bool alphaoverride);
225
226 /* view3d_draw_legacy.c */
227 void view3d_main_region_draw_legacy(const struct bContext *C, struct ARegion *ar);
228 void ED_view3d_draw_depth_gpencil(const struct EvaluationContext *eval_ctx, Scene *scene, ARegion *ar, View3D *v3d);
229
230 void ED_view3d_draw_select_loop(
231         const struct EvaluationContext *eval_ctx, ViewContext *vc, Scene *scene, struct ViewLayer *view_layer, View3D *v3d, ARegion *ar,
232         bool use_obedit_skip, bool use_nearest);
233
234 void ED_view3d_draw_depth_loop(
235         const struct EvaluationContext *eval_ctx, Scene *scene, ARegion *ar, View3D *v3d);
236
237 void ED_view3d_after_add(ListBase *lb, Base *base, const short dflag);
238
239 void view3d_update_depths_rect(struct ARegion *ar, struct ViewDepths *d, struct rcti *rect);
240 float view3d_depth_near(struct ViewDepths *d);
241
242 /* view3d_select.c */
243 void VIEW3D_OT_select(struct wmOperatorType *ot);
244 void VIEW3D_OT_select_circle(struct wmOperatorType *ot);
245 void VIEW3D_OT_select_border(struct wmOperatorType *ot);
246 void VIEW3D_OT_select_lasso(struct wmOperatorType *ot);
247 void VIEW3D_OT_select_menu(struct wmOperatorType *ot);
248
249 void VIEW3D_OT_smoothview(struct wmOperatorType *ot);
250 void VIEW3D_OT_camera_to_view(struct wmOperatorType *ot);
251 void VIEW3D_OT_camera_to_view_selected(struct wmOperatorType *ot);
252 void VIEW3D_OT_object_as_camera(struct wmOperatorType *ot);
253 void VIEW3D_OT_game_start(struct wmOperatorType *ot);
254
255
256 bool ED_view3d_boundbox_clip_ex(const RegionView3D *rv3d, const struct BoundBox *bb, float obmat[4][4]);
257 bool ED_view3d_boundbox_clip(RegionView3D *rv3d, const struct BoundBox *bb);
258
259 typedef struct V3D_SmoothParams {
260         struct Object *camera_old, *camera;
261         const float *ofs, *quat, *dist, *lens;
262         /* alternate rotation center (ofs = must be NULL) */
263         const float *dyn_ofs;
264 } V3D_SmoothParams;
265
266 void ED_view3d_smooth_view_ex(
267         struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa,
268         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
269         const V3D_SmoothParams *sview);
270
271 void ED_view3d_smooth_view(
272         struct bContext *C,
273         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
274         const V3D_SmoothParams *sview);
275
276 void ED_view3d_smooth_view_force_finish(
277         struct bContext *C,
278         struct View3D *v3d, struct ARegion *ar);
279
280 void view3d_winmatrix_set(
281         const struct Depsgraph *depsgraph,
282         ARegion *ar, const View3D *v3d, const rcti *rect);
283 void view3d_viewmatrix_set(
284         const struct EvaluationContext *eval_ctx, Scene *scene,
285         const View3D *v3d, RegionView3D *rv3d, const float rect_scale[2]);
286
287 void fly_modal_keymap(struct wmKeyConfig *keyconf);
288 void walk_modal_keymap(struct wmKeyConfig *keyconf);
289 void viewrotate_modal_keymap(struct wmKeyConfig *keyconf);
290 void viewmove_modal_keymap(struct wmKeyConfig *keyconf);
291 void viewzoom_modal_keymap(struct wmKeyConfig *keyconf);
292 void viewdolly_modal_keymap(struct wmKeyConfig *keyconf);
293
294 /* view3d_buttons.c */
295 void VIEW3D_OT_properties(struct wmOperatorType *ot);
296 void view3d_buttons_register(struct ARegionType *art);
297
298 /* view3d_camera_control.c */
299 struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
300         const struct EvaluationContext *eval_ctx, Scene *scene, View3D *v3d, RegionView3D *rv3d,
301         const bool use_parent_root);
302 void ED_view3d_cameracontrol_update(
303         struct View3DCameraControl *vctrl,
304         const bool use_autokey,
305         struct bContext *C, const bool do_rotate, const bool do_translate);
306 void ED_view3d_cameracontrol_release(
307         struct View3DCameraControl *vctrl,
308         const bool restore);
309 struct Object *ED_view3d_cameracontrol_object_get(
310         struct View3DCameraControl *vctrl);
311
312 /* view3d_toolbar.c */
313 void VIEW3D_OT_toolshelf(struct wmOperatorType *ot);
314 void view3d_toolshelf_register(struct ARegionType *art);
315 void view3d_tool_props_register(struct ARegionType *art);
316
317 /* view3d_snap.c */
318 bool ED_view3d_minmax_verts(struct Object *obedit, float min[3], float max[3]);
319
320 void VIEW3D_OT_snap_selected_to_grid(struct wmOperatorType *ot);
321 void VIEW3D_OT_snap_selected_to_cursor(struct wmOperatorType *ot);
322 void VIEW3D_OT_snap_selected_to_active(struct wmOperatorType *ot);
323 void VIEW3D_OT_snap_cursor_to_grid(struct wmOperatorType *ot);
324 void VIEW3D_OT_snap_cursor_to_center(struct wmOperatorType *ot);
325 void VIEW3D_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
326 void VIEW3D_OT_snap_cursor_to_active(struct wmOperatorType *ot);
327
328 /* space_view3d.c */
329 ARegion *view3d_has_buttons_region(ScrArea *sa);
330 ARegion *view3d_has_tools_region(ScrArea *sa);
331
332 extern const char *view3d_context_dir[]; /* doc access */
333
334 /* view3d_widgets.c */
335 void VIEW3D_WGT_lamp_spot(struct wmManipulatorGroupType *wgt);
336 void VIEW3D_WGT_lamp_area(struct wmManipulatorGroupType *wgt);
337 void VIEW3D_WGT_lamp_target(struct wmManipulatorGroupType *wgt);
338 void VIEW3D_WGT_camera(struct wmManipulatorGroupType *wgt);
339 void VIEW3D_WGT_camera_view(struct wmManipulatorGroupType *wgt);
340 void VIEW3D_WGT_force_field(struct wmManipulatorGroupType *wgt);
341 void VIEW3D_WGT_empty_image(struct wmManipulatorGroupType *wgt);
342 void VIEW3D_WGT_armature_spline(struct wmManipulatorGroupType *wgt);
343 void VIEW3D_WGT_navigate(struct wmManipulatorGroupType *wgt);
344
345 void VIEW3D_WGT_ruler(struct wmManipulatorGroupType *wgt);
346 void VIEW3D_WT_ruler_item(struct wmManipulatorType *wt);
347 void VIEW3D_OT_ruler_add(struct wmOperatorType *ot);
348
349 void VIEW3D_WT_navigate_rotate(struct wmManipulatorType *wt);
350
351 /* draw_volume.c */
352 void draw_smoke_volume(struct SmokeDomainSettings *sds, struct Object *ob,
353                        const float min[3], const float max[3],
354                        const float viewnormal[3]);
355
356 void draw_smoke_velocity(struct SmokeDomainSettings *domain, float viewnormal[3]);
357
358 /* workaround for trivial but noticeable camera bug caused by imprecision
359  * between view border calculation in 2D/3D space, workaround for bug [#28037].
360  * without this define we get the old behavior which is to try and align them
361  * both which _mostly_ works fine, but when the camera moves beyond ~1000 in
362  * any direction it starts to fail */
363 #define VIEW3D_CAMERA_BORDER_HACK
364 #ifdef VIEW3D_CAMERA_BORDER_HACK
365 extern unsigned char view3d_camera_border_hack_col[3];
366 extern bool view3d_camera_border_hack_test;
367 #endif
368
369 /* temporary for legacy viewport to work */
370 void VP_legacy_drawcursor(Scene *scene, struct ViewLayer *view_layer, ARegion *ar, View3D *v3d);
371 void VP_legacy_draw_view_axis(RegionView3D *rv3d, rcti *rect);
372 void VP_legacy_draw_viewport_name(ARegion *ar, View3D *v3d, rcti *rect);
373 void VP_legacy_draw_selected_name(Scene *scene, struct Object *ob, rcti *rect);
374 void VP_legacy_drawgrid(UnitSettings *unit, ARegion *ar, View3D *v3d, const char **grid_unit);
375 void VP_legacy_drawfloor(Scene *scene, View3D *v3d, const char **grid_unit, bool write_depth);
376 void VP_legacy_view3d_main_region_setup_view(const struct EvaluationContext *eval_ctx, Scene *scene, View3D *v3d, ARegion *ar, float viewmat[4][4], float winmat[4][4]);
377 bool VP_legacy_view3d_stereo3d_active(struct wmWindow *win, Scene *scene, View3D *v3d, RegionView3D *rv3d);
378 void VP_legacy_view3d_stereo3d_setup(const struct EvaluationContext *eval_ctx, Scene *scene, View3D *v3d, ARegion *ar);
379 void draw_dupli_objects(const struct EvaluationContext *eval_ctx, Scene *scene, ViewLayer *view_layer, ARegion *ar, View3D *v3d, Base *base);
380 bool VP_legacy_use_depth(Scene *scene, View3D *v3d);
381 void VP_drawviewborder(Scene *scene, const struct Depsgraph *depsgraph, ARegion *ar, View3D *v3d);
382 void VP_drawrenderborder(ARegion *ar, View3D *v3d);
383 void VP_view3d_draw_background_none(void);
384 void VP_view3d_draw_background_world(Scene *scene, RegionView3D *rv3d);
385 void VP_view3d_main_region_clear(Scene *scene, View3D *v3d, ARegion *ar);
386
387 /* temporary legacy calls, only when there is a switch between new/old draw calls */
388 void VP_deprecated_gpu_update_lamps_shadows_world(const struct EvaluationContext *eval_ctx, Scene *scene, View3D *v3d);
389 void VP_deprecated_view3d_draw_objects(
390         const struct bContext *C,
391         const struct EvaluationContext *eval_ctx,
392         Scene *scene, View3D *v3d, ARegion *ar,
393         const char **grid_unit,
394         const bool do_bgpic, const bool draw_offscreen, struct GPUFX *fx);
395
396 #endif /* __VIEW3D_INTERN_H__ */