4974e2269b339c80d8605fe01ffdbf30af6058f8
[blender.git] / source / blender / editors / space_view3d / view3d_intern.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spview3d
22  */
23
24 #ifndef __VIEW3D_INTERN_H__
25 #define __VIEW3D_INTERN_H__
26
27 #include "ED_view3d.h"
28
29 /* internal exports only */
30
31 struct ARegion;
32 struct ARegionType;
33 struct Base;
34 struct BoundBox;
35 struct Depsgraph;
36 struct GPUBatch;
37 struct Mesh;
38 struct Object;
39 struct SmokeDomainSettings;
40 struct ViewLayer;
41 struct bAnimVizSettings;
42 struct bContext;
43 struct bMotionPath;
44 struct bPoseChannel;
45 struct wmGizmoGroupType;
46 struct wmGizmoType;
47 struct wmKeyConfig;
48 struct wmOperatorType;
49 struct wmWindowManager;
50
51 /* drawing flags: */
52 enum {
53   DRAW_PICKING = (1 << 0),
54   DRAW_CONSTCOLOR = (1 << 1),
55   DRAW_SCENESET = (1 << 2),
56 };
57
58 /* view3d_header.c */
59 void VIEW3D_OT_toggle_matcap_flip(struct wmOperatorType *ot);
60
61 /* view3d_ops.c */
62 void view3d_operatortypes(void);
63
64 /* view3d_edit.c */
65 void VIEW3D_OT_zoom(struct wmOperatorType *ot);
66 void VIEW3D_OT_dolly(struct wmOperatorType *ot);
67 void VIEW3D_OT_zoom_camera_1_to_1(struct wmOperatorType *ot);
68 void VIEW3D_OT_move(struct wmOperatorType *ot);
69 void VIEW3D_OT_rotate(struct wmOperatorType *ot);
70 #ifdef WITH_INPUT_NDOF
71 void VIEW3D_OT_ndof_orbit(struct wmOperatorType *ot);
72 void VIEW3D_OT_ndof_orbit_zoom(struct wmOperatorType *ot);
73 void VIEW3D_OT_ndof_pan(struct wmOperatorType *ot);
74 void VIEW3D_OT_ndof_all(struct wmOperatorType *ot);
75 #endif /* WITH_INPUT_NDOF */
76 void VIEW3D_OT_view_all(struct wmOperatorType *ot);
77 void VIEW3D_OT_view_axis(struct wmOperatorType *ot);
78 void VIEW3D_OT_view_camera(struct wmOperatorType *ot);
79 void VIEW3D_OT_view_selected(struct wmOperatorType *ot);
80 void VIEW3D_OT_view_lock_clear(struct wmOperatorType *ot);
81 void VIEW3D_OT_view_lock_to_active(struct wmOperatorType *ot);
82 void VIEW3D_OT_view_center_cursor(struct wmOperatorType *ot);
83 void VIEW3D_OT_view_center_pick(struct wmOperatorType *ot);
84 void VIEW3D_OT_view_center_camera(struct wmOperatorType *ot);
85 void VIEW3D_OT_view_center_lock(struct wmOperatorType *ot);
86 void VIEW3D_OT_view_pan(struct wmOperatorType *ot);
87 void VIEW3D_OT_view_persportho(struct wmOperatorType *ot);
88 void VIEW3D_OT_navigate(struct wmOperatorType *ot);
89 void VIEW3D_OT_background_image_add(struct wmOperatorType *ot);
90 void VIEW3D_OT_background_image_remove(struct wmOperatorType *ot);
91 void VIEW3D_OT_view_orbit(struct wmOperatorType *ot);
92 void VIEW3D_OT_view_roll(struct wmOperatorType *ot);
93 void VIEW3D_OT_clip_border(struct wmOperatorType *ot);
94 void VIEW3D_OT_cursor3d(struct wmOperatorType *ot);
95 void VIEW3D_OT_render_border(struct wmOperatorType *ot);
96 void VIEW3D_OT_clear_render_border(struct wmOperatorType *ot);
97 void VIEW3D_OT_zoom_border(struct wmOperatorType *ot);
98 void VIEW3D_OT_toggle_shading(struct wmOperatorType *ot);
99 void VIEW3D_OT_toggle_xray(struct wmOperatorType *ot);
100
101 void view3d_boxview_copy(struct ScrArea *sa, struct ARegion *ar);
102 void view3d_boxview_sync(struct ScrArea *sa, struct ARegion *ar);
103
104 void view3d_orbit_apply_dyn_ofs(float r_ofs[3],
105                                 const float ofs_old[3],
106                                 const float viewquat_old[4],
107                                 const float viewquat_new[4],
108                                 const float dyn_ofs[3]);
109
110 #ifdef WITH_INPUT_NDOF
111 struct wmNDOFMotionData;
112
113 void view3d_ndof_fly(const struct wmNDOFMotionData *ndof,
114                      struct View3D *v3d,
115                      struct RegionView3D *rv3d,
116                      const bool use_precision,
117                      const short protectflag,
118                      bool *r_has_translate,
119                      bool *r_has_rotate);
120 #endif /* WITH_INPUT_NDOF */
121
122 /* view3d_fly.c */
123 void view3d_keymap(struct wmKeyConfig *keyconf);
124 void VIEW3D_OT_fly(struct wmOperatorType *ot);
125
126 /* view3d_walk.c */
127 void VIEW3D_OT_walk(struct wmOperatorType *ot);
128
129 /* drawobject.c */
130 void draw_object_select_id(struct Depsgraph *depsgraph,
131                            Scene *scene,
132                            View3D *v3d,
133                            RegionView3D *rv3d,
134                            struct Object *ob,
135                            short select_mode);
136
137 void draw_object_depth(RegionView3D *rv3d, struct Object *ob);
138
139 int view3d_effective_drawtype(const struct View3D *v3d);
140
141 /* view3d_draw.c */
142 void view3d_main_region_draw(const struct bContext *C, struct ARegion *ar);
143 void view3d_draw_region_info(const struct bContext *C, struct ARegion *ar);
144
145 void ED_view3d_draw_depth(struct Depsgraph *depsgraph,
146                           struct ARegion *ar,
147                           View3D *v3d,
148                           bool alphaoverride);
149
150 /* view3d_draw_legacy.c */
151 void ED_view3d_draw_depth_gpencil(struct Depsgraph *depsgraph,
152                                   Scene *scene,
153                                   struct ARegion *ar,
154                                   View3D *v3d);
155
156 void ED_view3d_draw_select_loop(struct Depsgraph *depsgraph,
157                                 ViewContext *vc,
158                                 Scene *scene,
159                                 struct ViewLayer *view_layer,
160                                 View3D *v3d,
161                                 struct ARegion *ar,
162                                 bool use_obedit_skip,
163                                 bool use_nearest);
164
165 void ED_view3d_draw_depth_loop(struct Depsgraph *depsgraph,
166                                Scene *scene,
167                                struct ARegion *ar,
168                                View3D *v3d);
169
170 void view3d_update_depths_rect(struct ARegion *ar, struct ViewDepths *d, struct rcti *rect);
171 float view3d_depth_near(struct ViewDepths *d);
172
173 /* view3d_select.c */
174 void VIEW3D_OT_select(struct wmOperatorType *ot);
175 void VIEW3D_OT_select_circle(struct wmOperatorType *ot);
176 void VIEW3D_OT_select_box(struct wmOperatorType *ot);
177 void VIEW3D_OT_select_lasso(struct wmOperatorType *ot);
178 void VIEW3D_OT_select_menu(struct wmOperatorType *ot);
179
180 /* view3d_view.c */
181 void VIEW3D_OT_smoothview(struct wmOperatorType *ot);
182 void VIEW3D_OT_camera_to_view(struct wmOperatorType *ot);
183 void VIEW3D_OT_camera_to_view_selected(struct wmOperatorType *ot);
184 void VIEW3D_OT_object_as_camera(struct wmOperatorType *ot);
185 void VIEW3D_OT_localview(struct wmOperatorType *ot);
186 void VIEW3D_OT_localview_remove_from(struct wmOperatorType *ot);
187
188 bool ED_view3d_boundbox_clip_ex(const RegionView3D *rv3d,
189                                 const struct BoundBox *bb,
190                                 float obmat[4][4]);
191 bool ED_view3d_boundbox_clip(RegionView3D *rv3d, const struct BoundBox *bb);
192
193 typedef struct V3D_SmoothParams {
194   struct Object *camera_old, *camera;
195   const float *ofs, *quat, *dist, *lens;
196   /* alternate rotation center (ofs = must be NULL) */
197   const float *dyn_ofs;
198 } V3D_SmoothParams;
199
200 void ED_view3d_smooth_view_ex(const struct Depsgraph *depsgraph,
201                               struct wmWindowManager *wm,
202                               struct wmWindow *win,
203                               struct ScrArea *sa,
204                               struct View3D *v3d,
205                               struct ARegion *ar,
206                               const int smooth_viewtx,
207                               const V3D_SmoothParams *sview);
208
209 void ED_view3d_smooth_view(struct bContext *C,
210                            struct View3D *v3d,
211                            struct ARegion *ar,
212                            const int smooth_viewtx,
213                            const V3D_SmoothParams *sview);
214
215 void ED_view3d_smooth_view_force_finish(struct bContext *C,
216                                         struct View3D *v3d,
217                                         struct ARegion *ar);
218
219 void view3d_winmatrix_set(struct Depsgraph *depsgraph,
220                           struct ARegion *ar,
221                           const View3D *v3d,
222                           const rcti *rect);
223 void view3d_viewmatrix_set(struct Depsgraph *depsgraph,
224                            Scene *scene,
225                            const View3D *v3d,
226                            RegionView3D *rv3d,
227                            const float rect_scale[2]);
228
229 void fly_modal_keymap(struct wmKeyConfig *keyconf);
230 void walk_modal_keymap(struct wmKeyConfig *keyconf);
231 void viewrotate_modal_keymap(struct wmKeyConfig *keyconf);
232 void viewmove_modal_keymap(struct wmKeyConfig *keyconf);
233 void viewzoom_modal_keymap(struct wmKeyConfig *keyconf);
234 void viewdolly_modal_keymap(struct wmKeyConfig *keyconf);
235
236 /* view3d_buttons.c */
237 void VIEW3D_OT_object_mode_pie_or_toggle(struct wmOperatorType *ot);
238 void view3d_buttons_register(struct ARegionType *art);
239
240 /* view3d_camera_control.c */
241 struct View3DCameraControl *ED_view3d_cameracontrol_acquire(struct Depsgraph *depsgraph,
242                                                             Scene *scene,
243                                                             View3D *v3d,
244                                                             RegionView3D *rv3d,
245                                                             const bool use_parent_root);
246 void ED_view3d_cameracontrol_update(struct View3DCameraControl *vctrl,
247                                     const bool use_autokey,
248                                     struct bContext *C,
249                                     const bool do_rotate,
250                                     const bool do_translate);
251 void ED_view3d_cameracontrol_release(struct View3DCameraControl *vctrl, const bool restore);
252 struct Object *ED_view3d_cameracontrol_object_get(struct View3DCameraControl *vctrl);
253
254 /* view3d_toolbar.c */
255 void VIEW3D_OT_toolshelf(struct wmOperatorType *ot);
256
257 /* view3d_snap.c */
258 bool ED_view3d_minmax_verts(struct Object *obedit, float min[3], float max[3]);
259
260 void VIEW3D_OT_snap_selected_to_grid(struct wmOperatorType *ot);
261 void VIEW3D_OT_snap_selected_to_cursor(struct wmOperatorType *ot);
262 void VIEW3D_OT_snap_selected_to_active(struct wmOperatorType *ot);
263 void VIEW3D_OT_snap_cursor_to_grid(struct wmOperatorType *ot);
264 void VIEW3D_OT_snap_cursor_to_center(struct wmOperatorType *ot);
265 void VIEW3D_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
266 void VIEW3D_OT_snap_cursor_to_active(struct wmOperatorType *ot);
267
268 /* space_view3d.c */
269 struct ARegion *view3d_has_buttons_region(struct ScrArea *sa);
270 struct ARegion *view3d_has_tools_region(struct ScrArea *sa);
271
272 extern const char *view3d_context_dir[]; /* doc access */
273
274 /* view3d_widgets.c */
275 void VIEW3D_GGT_light_spot(struct wmGizmoGroupType *gzgt);
276 void VIEW3D_GGT_light_area(struct wmGizmoGroupType *gzgt);
277 void VIEW3D_GGT_light_target(struct wmGizmoGroupType *gzgt);
278 void VIEW3D_GGT_camera(struct wmGizmoGroupType *gzgt);
279 void VIEW3D_GGT_camera_view(struct wmGizmoGroupType *gzgt);
280 void VIEW3D_GGT_force_field(struct wmGizmoGroupType *gzgt);
281 void VIEW3D_GGT_empty_image(struct wmGizmoGroupType *gzgt);
282 void VIEW3D_GGT_armature_spline(struct wmGizmoGroupType *gzgt);
283 void VIEW3D_GGT_navigate(struct wmGizmoGroupType *gzgt);
284 void VIEW3D_GGT_mesh_preselect_elem(struct wmGizmoGroupType *gzgt);
285 void VIEW3D_GGT_mesh_preselect_edgering(struct wmGizmoGroupType *gzgt);
286
287 void VIEW3D_GGT_ruler(struct wmGizmoGroupType *gzgt);
288 void VIEW3D_GT_ruler_item(struct wmGizmoType *gzt);
289 void VIEW3D_OT_ruler_add(struct wmOperatorType *ot);
290 void VIEW3D_OT_ruler_remove(struct wmOperatorType *ot);
291
292 void VIEW3D_GT_navigate_rotate(struct wmGizmoType *gzt);
293
294 /* workaround for trivial but noticeable camera bug caused by imprecision
295  * between view border calculation in 2D/3D space, workaround for bug [#28037].
296  * without this define we get the old behavior which is to try and align them
297  * both which _mostly_ works fine, but when the camera moves beyond ~1000 in
298  * any direction it starts to fail */
299 #define VIEW3D_CAMERA_BORDER_HACK
300 #ifdef VIEW3D_CAMERA_BORDER_HACK
301 extern uchar view3d_camera_border_hack_col[3];
302 extern bool view3d_camera_border_hack_test;
303 #endif
304
305 #endif /* __VIEW3D_INTERN_H__ */