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