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