9f77f671a7dd103476d2b907cbafdfda41cc903e
[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 GPUBatch;
43 struct Depsgraph;
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 wmGizmoGroupType;
55 struct wmGizmoType;
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 /* view3d_header.c */
66 void VIEW3D_OT_layers(struct wmOperatorType *ot);
67 void VIEW3D_OT_toggle_matcap_flip(struct wmOperatorType *ot);
68
69 /* view3d_ops.c */
70 void view3d_operatortypes(void);
71
72 /* view3d_edit.c */
73 void VIEW3D_OT_zoom(struct wmOperatorType *ot);
74 void VIEW3D_OT_dolly(struct wmOperatorType *ot);
75 void VIEW3D_OT_zoom_camera_1_to_1(struct wmOperatorType *ot);
76 void VIEW3D_OT_move(struct wmOperatorType *ot);
77 void VIEW3D_OT_rotate(struct wmOperatorType *ot);
78 #ifdef WITH_INPUT_NDOF
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 #endif /* WITH_INPUT_NDOF */
84 void VIEW3D_OT_view_all(struct wmOperatorType *ot);
85 void VIEW3D_OT_view_axis(struct wmOperatorType *ot);
86 void VIEW3D_OT_view_camera(struct wmOperatorType *ot);
87 void VIEW3D_OT_view_selected(struct wmOperatorType *ot);
88 void VIEW3D_OT_view_lock_clear(struct wmOperatorType *ot);
89 void VIEW3D_OT_view_lock_to_active(struct wmOperatorType *ot);
90 void VIEW3D_OT_view_center_cursor(struct wmOperatorType *ot);
91 void VIEW3D_OT_view_center_pick(struct wmOperatorType *ot);
92 void VIEW3D_OT_view_center_camera(struct wmOperatorType *ot);
93 void VIEW3D_OT_view_center_lock(struct wmOperatorType *ot);
94 void VIEW3D_OT_view_pan(struct wmOperatorType *ot);
95 void VIEW3D_OT_view_persportho(struct wmOperatorType *ot);
96 void VIEW3D_OT_navigate(struct wmOperatorType *ot);
97 void VIEW3D_OT_background_image_add(struct wmOperatorType *ot);
98 void VIEW3D_OT_background_image_remove(struct wmOperatorType *ot);
99 void VIEW3D_OT_view_orbit(struct wmOperatorType *ot);
100 void VIEW3D_OT_view_roll(struct wmOperatorType *ot);
101 // void VIEW3D_OT_clip_border(struct wmOperatorType *ot);
102 void VIEW3D_OT_cursor3d(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_shading(struct wmOperatorType *ot);
107 void VIEW3D_OT_toggle_xray(struct wmOperatorType *ot);
108
109 void view3d_boxview_copy(struct ScrArea *sa, struct ARegion *ar);
110 void view3d_boxview_sync(struct ScrArea *sa, struct ARegion *ar);
111
112 void view3d_orbit_apply_dyn_ofs(
113         float r_ofs[3], const float ofs_old[3], const float viewquat_old[4],
114         const float viewquat_new[4], const float dyn_ofs[3]);
115
116 #ifdef WITH_INPUT_NDOF
117 struct wmNDOFMotionData;
118
119 void view3d_ndof_fly(
120         const struct wmNDOFMotionData *ndof,
121         struct View3D *v3d, struct RegionView3D *rv3d,
122         const bool use_precision, const short protectflag,
123         bool *r_has_translate, bool *r_has_rotate);
124 #endif /* WITH_INPUT_NDOF */
125
126 /* view3d_fly.c */
127 void view3d_keymap(struct wmKeyConfig *keyconf);
128 void VIEW3D_OT_fly(struct wmOperatorType *ot);
129
130 /* view3d_walk.c */
131 void VIEW3D_OT_walk(struct wmOperatorType *ot);
132
133 /* view3d_ruler.c */
134 void VIEW3D_OT_ruler(struct wmOperatorType *ot);
135
136 /* drawobject.c */
137 void draw_object_backbufsel(
138         struct Depsgraph *depsgraph, Scene *scene,
139         View3D *v3d, RegionView3D *rv3d, struct Object *ob,
140         short select_mode);
141
142 int view3d_effective_drawtype(const struct View3D *v3d);
143
144 /* view3d_draw.c */
145 void view3d_main_region_draw(const struct bContext *C, struct ARegion *ar);
146 void view3d_draw_region_info(const struct bContext *C, struct ARegion *ar);
147
148 void ED_view3d_draw_depth(
149         struct Depsgraph *depsgraph,
150         struct ARegion *ar, View3D *v3d, bool alphaoverride);
151
152 /* view3d_draw_legacy.c */
153 void ED_view3d_draw_depth_gpencil(struct Depsgraph *depsgraph, Scene *scene, struct ARegion *ar, View3D *v3d);
154
155 void ED_view3d_draw_select_loop(
156         struct Depsgraph *depsgraph, ViewContext *vc, Scene *scene, struct ViewLayer *view_layer, View3D *v3d, struct ARegion *ar,
157         bool use_obedit_skip, bool use_nearest);
158
159 void ED_view3d_draw_depth_loop(
160         struct Depsgraph *depsgraph, Scene *scene, struct ARegion *ar, View3D *v3d);
161
162 void ED_view3d_after_add(ListBase *lb, Base *base, const short dflag);
163
164 void view3d_update_depths_rect(struct ARegion *ar, struct ViewDepths *d, struct rcti *rect);
165 float view3d_depth_near(struct ViewDepths *d);
166
167 /* view3d_select.c */
168 void VIEW3D_OT_select(struct wmOperatorType *ot);
169 void VIEW3D_OT_select_circle(struct wmOperatorType *ot);
170 void VIEW3D_OT_select_box(struct wmOperatorType *ot);
171 void VIEW3D_OT_select_lasso(struct wmOperatorType *ot);
172 void VIEW3D_OT_select_menu(struct wmOperatorType *ot);
173
174 /* view3d_view.c */
175 void VIEW3D_OT_smoothview(struct wmOperatorType *ot);
176 void VIEW3D_OT_camera_to_view(struct wmOperatorType *ot);
177 void VIEW3D_OT_camera_to_view_selected(struct wmOperatorType *ot);
178 void VIEW3D_OT_object_as_camera(struct wmOperatorType *ot);
179 void VIEW3D_OT_localview(struct wmOperatorType *ot);
180
181 bool ED_view3d_boundbox_clip_ex(const RegionView3D *rv3d, const struct BoundBox *bb, float obmat[4][4]);
182 bool ED_view3d_boundbox_clip(RegionView3D *rv3d, const struct BoundBox *bb);
183
184 typedef struct V3D_SmoothParams {
185         struct Object *camera_old, *camera;
186         const float *ofs, *quat, *dist, *lens;
187         /* alternate rotation center (ofs = must be NULL) */
188         const float *dyn_ofs;
189 } V3D_SmoothParams;
190
191 void ED_view3d_smooth_view_ex(
192         const struct Depsgraph *depsgraph,
193         struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa,
194         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
195         const V3D_SmoothParams *sview);
196
197 void ED_view3d_smooth_view(
198         struct bContext *C,
199         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
200         const V3D_SmoothParams *sview);
201
202 void ED_view3d_smooth_view_force_finish(
203         struct bContext *C,
204         struct View3D *v3d, struct ARegion *ar);
205
206 void view3d_winmatrix_set(
207         struct Depsgraph *depsgraph,
208         struct ARegion *ar, const View3D *v3d, const rcti *rect);
209 void view3d_viewmatrix_set(
210         struct Depsgraph *depsgraph, Scene *scene,
211         const View3D *v3d, RegionView3D *rv3d, const float rect_scale[2]);
212
213 void fly_modal_keymap(struct wmKeyConfig *keyconf);
214 void walk_modal_keymap(struct wmKeyConfig *keyconf);
215 void viewrotate_modal_keymap(struct wmKeyConfig *keyconf);
216 void viewmove_modal_keymap(struct wmKeyConfig *keyconf);
217 void viewzoom_modal_keymap(struct wmKeyConfig *keyconf);
218 void viewdolly_modal_keymap(struct wmKeyConfig *keyconf);
219
220 /* view3d_buttons.c */
221 void VIEW3D_OT_properties(struct wmOperatorType *ot);
222 void VIEW3D_OT_object_mode_pie_or_toggle(struct wmOperatorType *ot);
223 void view3d_buttons_register(struct ARegionType *art);
224
225 /* view3d_camera_control.c */
226 struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
227         struct Depsgraph *depsgraph, Scene *scene, View3D *v3d, RegionView3D *rv3d,
228         const bool use_parent_root);
229 void ED_view3d_cameracontrol_update(
230         struct View3DCameraControl *vctrl,
231         const bool use_autokey,
232         struct bContext *C, const bool do_rotate, const bool do_translate);
233 void ED_view3d_cameracontrol_release(
234         struct View3DCameraControl *vctrl,
235         const bool restore);
236 struct Object *ED_view3d_cameracontrol_object_get(
237         struct View3DCameraControl *vctrl);
238
239 /* view3d_toolbar.c */
240 void VIEW3D_OT_toolshelf(struct wmOperatorType *ot);
241
242 /* view3d_snap.c */
243 bool ED_view3d_minmax_verts(struct Object *obedit, float min[3], float max[3]);
244
245 void VIEW3D_OT_snap_selected_to_grid(struct wmOperatorType *ot);
246 void VIEW3D_OT_snap_selected_to_cursor(struct wmOperatorType *ot);
247 void VIEW3D_OT_snap_selected_to_active(struct wmOperatorType *ot);
248 void VIEW3D_OT_snap_cursor_to_grid(struct wmOperatorType *ot);
249 void VIEW3D_OT_snap_cursor_to_center(struct wmOperatorType *ot);
250 void VIEW3D_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
251 void VIEW3D_OT_snap_cursor_to_active(struct wmOperatorType *ot);
252
253 /* space_view3d.c */
254 struct ARegion *view3d_has_buttons_region(struct ScrArea *sa);
255 struct ARegion *view3d_has_tools_region(struct ScrArea *sa);
256
257 extern const char *view3d_context_dir[]; /* doc access */
258
259 /* view3d_widgets.c */
260 void VIEW3D_GGT_lamp_spot(struct wmGizmoGroupType *gzgt);
261 void VIEW3D_GGT_lamp_area(struct wmGizmoGroupType *gzgt);
262 void VIEW3D_GGT_lamp_target(struct wmGizmoGroupType *gzgt);
263 void VIEW3D_GGT_camera(struct wmGizmoGroupType *gzgt);
264 void VIEW3D_GGT_camera_view(struct wmGizmoGroupType *gzgt);
265 void VIEW3D_GGT_force_field(struct wmGizmoGroupType *gzgt);
266 void VIEW3D_GGT_empty_image(struct wmGizmoGroupType *gzgt);
267 void VIEW3D_GGT_armature_spline(struct wmGizmoGroupType *gzgt);
268 void VIEW3D_GGT_navigate(struct wmGizmoGroupType *gzgt);
269 void VIEW3D_GGT_mesh_preselect_elem(struct wmGizmoGroupType *gzgt);
270 void VIEW3D_GGT_mesh_preselect_edgering(struct wmGizmoGroupType *gzgt);
271
272 void VIEW3D_GGT_ruler(struct wmGizmoGroupType *gzgt);
273 void VIEW3D_GT_ruler_item(struct wmGizmoType *gzt);
274 void VIEW3D_OT_ruler_add(struct wmOperatorType *ot);
275
276 void VIEW3D_GT_navigate_rotate(struct wmGizmoType *gzt);
277
278 /* draw_volume.c */
279 void draw_smoke_volume(struct SmokeDomainSettings *sds, struct Object *ob,
280                        const float min[3], const float max[3],
281                        const float viewnormal[3]);
282
283 void draw_smoke_velocity(struct SmokeDomainSettings *domain, float viewnormal[3]);
284
285 /* workaround for trivial but noticeable camera bug caused by imprecision
286  * between view border calculation in 2D/3D space, workaround for bug [#28037].
287  * without this define we get the old behavior which is to try and align them
288  * both which _mostly_ works fine, but when the camera moves beyond ~1000 in
289  * any direction it starts to fail */
290 #define VIEW3D_CAMERA_BORDER_HACK
291 #ifdef VIEW3D_CAMERA_BORDER_HACK
292 extern unsigned char view3d_camera_border_hack_col[3];
293 extern bool view3d_camera_border_hack_test;
294 #endif
295
296 #endif /* __VIEW3D_INTERN_H__ */