71d6a47c41c3714aa2ed8b01d60e2a97f30424df
[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 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 wmOperatorType;
51 struct wmWindowManager;
52 struct wmKeyConfig;
53
54 /* drawing flags: */
55 enum {
56         DRAW_PICKING     = (1 << 0),
57         DRAW_CONSTCOLOR  = (1 << 1),
58         DRAW_SCENESET    = (1 << 2)
59 };
60
61 /* draw_mesh_fancy/draw_mesh_textured draw_flags */
62 enum {
63         DRAW_MODIFIERS_PREVIEW  = (1 << 0),
64         DRAW_FACE_SELECT        = (1 << 1)
65 };
66
67 /* view3d_header.c */
68 void VIEW3D_OT_layers(struct wmOperatorType *ot);
69
70 /* view3d_ops.c */
71 void view3d_operatortypes(void);
72
73 /* view3d_edit.c */
74 void VIEW3D_OT_zoom(struct wmOperatorType *ot);
75 void VIEW3D_OT_dolly(struct wmOperatorType *ot);
76 void VIEW3D_OT_zoom_camera_1_to_1(struct wmOperatorType *ot);
77 void VIEW3D_OT_move(struct wmOperatorType *ot);
78 void VIEW3D_OT_rotate(struct wmOperatorType *ot);
79 #ifdef WITH_INPUT_NDOF
80 void VIEW3D_OT_ndof_orbit(struct wmOperatorType *ot);
81 void VIEW3D_OT_ndof_orbit_zoom(struct wmOperatorType *ot);
82 void VIEW3D_OT_ndof_pan(struct wmOperatorType *ot);
83 void VIEW3D_OT_ndof_all(struct wmOperatorType *ot);
84 #endif /* WITH_INPUT_NDOF */
85 void VIEW3D_OT_view_all(struct wmOperatorType *ot);
86 void VIEW3D_OT_viewnumpad(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_manipulator(struct wmOperatorType *ot);
104 void VIEW3D_OT_enable_manipulator(struct wmOperatorType *ot);
105 void VIEW3D_OT_render_border(struct wmOperatorType *ot);
106 void VIEW3D_OT_clear_render_border(struct wmOperatorType *ot);
107 void VIEW3D_OT_zoom_border(struct wmOperatorType *ot);
108 void VIEW3D_OT_toggle_render(struct wmOperatorType *ot);
109
110 void view3d_boxview_copy(ScrArea *sa, 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 /* drawanim.c */
137 void draw_motion_paths_init(View3D *v3d, struct ARegion *ar);
138 void draw_motion_path_instance(Scene *scene,
139                                struct Object *ob, struct bPoseChannel *pchan,
140                                struct bAnimVizSettings *avs, struct bMotionPath *mpath);
141 void draw_motion_paths_cleanup(View3D *v3d);
142
143
144
145 /* drawobject.c */
146 void draw_object(Scene *scene, struct ARegion *ar, View3D *v3d, Base *base, const short dflag);
147 void draw_mesh_object_outline(View3D *v3d, Object *ob, struct DerivedMesh *dm);
148
149 bool draw_glsl_material(Scene *scene, struct Object *ob, View3D *v3d, const char dt);
150 void draw_object_instance(Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob, const char dt, int outline);
151 void draw_object_backbufsel(Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob);
152
153 void draw_object_wire_color(Scene *scene, Base *base, unsigned char r_ob_wire_col[4]);
154 void drawaxes(const float viewmat_local[4][4], float size, char drawtype, const unsigned char color[4]);
155 void drawlamp(View3D *v3d, RegionView3D *rv3d, Base *base,
156               const char dt, const short dflag, const unsigned char ob_wire_col[4],
157               const bool is_obact);
158 void drawcamera(Scene *scene, View3D *v3d, RegionView3D *rv3d, Base *base,
159                 const short dflag, const unsigned char ob_wire_col[4]);
160 void drawspeaker(const unsigned char ob_wire_col[3]);
161 void draw_bounding_volume(struct Object *ob, char type);
162 void draw_rigidbody_shape(struct Object *ob);
163
164 void view3d_cached_text_draw_begin(void);
165 void view3d_cached_text_draw_add(const float co[3],
166                                  const char *str, const size_t str_len,
167                                  short xoffs, short flag, const unsigned char col[4]);
168 void view3d_cached_text_draw_end(View3D *v3d, ARegion *ar, bool depth_write, float mat[4][4]);
169
170 bool check_object_draw_texture(struct Scene *scene, struct View3D *v3d, const char drawtype);
171
172 enum {
173         V3D_CACHE_TEXT_ZBUF         = (1 << 0),
174         V3D_CACHE_TEXT_WORLDSPACE   = (1 << 1),
175         V3D_CACHE_TEXT_ASCII        = (1 << 2),
176         V3D_CACHE_TEXT_GLOBALSPACE  = (1 << 3),
177         V3D_CACHE_TEXT_LOCALCLIP    = (1 << 4)
178 };
179
180 int view3d_effective_drawtype(const struct View3D *v3d);
181
182 /* drawarmature.c */
183 bool draw_armature(Scene *scene, View3D *v3d, ARegion *ar, Base *base,
184                    const short dt, const short dflag, const unsigned char ob_wire_col[4],
185                    const bool is_outline);
186
187 /* drawmesh.c */
188 void draw_mesh_textured(Scene *scene, View3D *v3d, RegionView3D *rv3d,
189                         struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
190 void draw_mesh_face_select(
191         struct RegionView3D *rv3d, struct Mesh *me, struct DerivedMesh *dm,
192         bool draw_select_edges);
193 void draw_mesh_paint_weight_faces(struct DerivedMesh *dm, const bool do_light,
194                                   void *facemask_cb, void *user_data);
195 void draw_mesh_paint_vcolor_faces(struct DerivedMesh *dm, const bool use_light,
196                                   void *facemask_cb, void *user_data,
197                                   const struct Mesh *me);
198 void draw_mesh_paint_weight_edges(RegionView3D *rv3d, struct DerivedMesh *dm,
199                                   const bool use_depth, const bool use_alpha,
200                                   void *edgemask_cb, void *user_data);
201 void draw_mesh_paint(View3D *v3d, RegionView3D *rv3d,
202                      struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
203
204 /* drawsimdebug.c */
205 void draw_sim_debug_data(Scene *scene, View3D *v3d, ARegion *ar);
206
207 /* view3d_draw.c */
208 void view3d_main_region_draw(const struct bContext *C, struct ARegion *ar);
209
210 /* view3d_draw_legacy.c */
211 void view3d_main_region_draw_legacy(const struct bContext *C, struct ARegion *ar);
212 void ED_view3d_draw_depth(Scene *scene, struct ARegion *ar, View3D *v3d, bool alphaoverride);
213 void ED_view3d_draw_depth_gpencil(Scene *scene, ARegion *ar, View3D *v3d);
214 void ED_view3d_after_add(ListBase *lb, Base *base, const short dflag);
215
216 void circ(float x, float y, float rad);
217 void view3d_update_depths_rect(struct ARegion *ar, struct ViewDepths *d, struct rcti *rect);
218 float view3d_depth_near(struct ViewDepths *d);
219
220 /* view3d_select.c */
221 void VIEW3D_OT_select(struct wmOperatorType *ot);
222 void VIEW3D_OT_select_circle(struct wmOperatorType *ot);
223 void VIEW3D_OT_select_border(struct wmOperatorType *ot);
224 void VIEW3D_OT_select_lasso(struct wmOperatorType *ot);
225 void VIEW3D_OT_select_menu(struct wmOperatorType *ot);
226
227 void VIEW3D_OT_smoothview(struct wmOperatorType *ot);
228 void VIEW3D_OT_camera_to_view(struct wmOperatorType *ot);
229 void VIEW3D_OT_camera_to_view_selected(struct wmOperatorType *ot);
230 void VIEW3D_OT_object_as_camera(struct wmOperatorType *ot);
231 void VIEW3D_OT_localview(struct wmOperatorType *ot);
232 void VIEW3D_OT_game_start(struct wmOperatorType *ot);
233
234
235 bool ED_view3d_boundbox_clip_ex(const RegionView3D *rv3d, const struct BoundBox *bb, float obmat[4][4]);
236 bool ED_view3d_boundbox_clip(RegionView3D *rv3d, const struct BoundBox *bb);
237
238 typedef struct V3D_SmoothParams {
239         struct Object *camera_old, *camera;
240         const float *ofs, *quat, *dist, *lens;
241         /* alternate rotation center (ofs = must be NULL) */
242         const float *dyn_ofs;
243 } V3D_SmoothParams;
244
245 void ED_view3d_smooth_view_ex(
246         struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa,
247         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
248         const V3D_SmoothParams *sview);
249
250 void ED_view3d_smooth_view(
251         struct bContext *C,
252         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
253         const V3D_SmoothParams *sview);
254
255 void ED_view3d_smooth_view_force_finish(
256         struct bContext *C,
257         struct View3D *v3d, struct ARegion *ar);
258
259 void view3d_winmatrix_set(ARegion *ar, const View3D *v3d, const rctf *rect);
260 void view3d_viewmatrix_set(Scene *scene, const View3D *v3d, RegionView3D *rv3d);
261
262 void fly_modal_keymap(struct wmKeyConfig *keyconf);
263 void walk_modal_keymap(struct wmKeyConfig *keyconf);
264 void viewrotate_modal_keymap(struct wmKeyConfig *keyconf);
265 void viewmove_modal_keymap(struct wmKeyConfig *keyconf);
266 void viewzoom_modal_keymap(struct wmKeyConfig *keyconf);
267 void viewdolly_modal_keymap(struct wmKeyConfig *keyconf);
268
269 /* view3d_buttons.c */
270 void VIEW3D_OT_properties(struct wmOperatorType *ot);
271 void view3d_buttons_register(struct ARegionType *art);
272
273 /* view3d_camera_control.c */
274 struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
275         Scene *scene, View3D *v3d, RegionView3D *rv3d,
276         const bool use_parent_root);
277 void ED_view3d_cameracontrol_update(
278         struct View3DCameraControl *vctrl,
279         const bool use_autokey,
280         struct bContext *C, const bool do_rotate, const bool do_translate);
281 void ED_view3d_cameracontrol_release(
282         struct View3DCameraControl *vctrl,
283         const bool restore);
284 Object *ED_view3d_cameracontrol_object_get(
285         struct View3DCameraControl *vctrl);
286
287 /* view3d_toolbar.c */
288 void VIEW3D_OT_toolshelf(struct wmOperatorType *ot);
289 void view3d_toolshelf_register(struct ARegionType *art);
290 void view3d_tool_props_register(struct ARegionType *art);
291
292 /* view3d_snap.c */
293 bool ED_view3d_minmax_verts(struct Object *obedit, float min[3], float max[3]);
294
295 void VIEW3D_OT_snap_selected_to_grid(struct wmOperatorType *ot);
296 void VIEW3D_OT_snap_selected_to_cursor(struct wmOperatorType *ot);
297 void VIEW3D_OT_snap_selected_to_active(struct wmOperatorType *ot);
298 void VIEW3D_OT_snap_cursor_to_grid(struct wmOperatorType *ot);
299 void VIEW3D_OT_snap_cursor_to_center(struct wmOperatorType *ot);
300 void VIEW3D_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
301 void VIEW3D_OT_snap_cursor_to_active(struct wmOperatorType *ot);
302
303 /* space_view3d.c */
304 ARegion *view3d_has_buttons_region(ScrArea *sa);
305 ARegion *view3d_has_tools_region(ScrArea *sa);
306
307 extern const char *view3d_context_dir[]; /* doc access */
308
309 /* draw_volume.c */
310 void draw_smoke_volume(struct SmokeDomainSettings *sds, struct Object *ob,
311                        const float min[3], const float max[3],
312                        const float viewnormal[3]);
313
314 void draw_smoke_velocity(struct SmokeDomainSettings *domain, float viewnormal[3]);
315
316 /* workaround for trivial but noticeable camera bug caused by imprecision
317  * between view border calculation in 2D/3D space, workaround for bug [#28037].
318  * without this define we get the old behavior which is to try and align them
319  * both which _mostly_ works fine, but when the camera moves beyond ~1000 in
320  * any direction it starts to fail */
321 #define VIEW3D_CAMERA_BORDER_HACK
322 #ifdef VIEW3D_CAMERA_BORDER_HACK
323 extern unsigned char view3d_camera_border_hack_col[3];
324 extern bool view3d_camera_border_hack_test;
325 #endif
326
327 /* temporary test for blender 2.8 viewport */
328 #define IS_VIEWPORT_LEGACY(v3d) ((v3d->tmp_compat_flag & V3D_NEW_VIEWPORT) == 0)
329
330 /* temporary for legacy viewport to work */
331 void VP_legacy_drawcursor(Scene *scene, ARegion *ar, View3D *v3d);
332 void VP_legacy_draw_view_axis(RegionView3D *rv3d, rcti *rect);
333 void VP_legacy_drawgrid(UnitSettings *unit, ARegion *ar, View3D *v3d, const char **grid_unit);
334 void VP_legacy_drawfloor(Scene *scene, View3D *v3d, const char **grid_unit, bool write_depth);
335 void VP_legacy_view3d_main_region_setup_view(Scene *scene, View3D *v3d, ARegion *ar, float viewmat[4][4], float winmat[4][4]);
336 bool VP_legacy_view3d_stereo3d_active(const struct bContext *C, Scene *scene, View3D *v3d, RegionView3D *rv3d);
337 void VP_legacy_view3d_stereo3d_setup(Scene *scene, View3D *v3d, ARegion *ar);
338 void draw_dupli_objects(Scene *scene, ARegion *ar, View3D *v3d, Base *base);
339 bool VP_legacy_use_depth(Scene *scene, View3D *v3d);
340 void VP_drawviewborder(Scene *scene, ARegion *ar, View3D *v3d);
341 void VP_drawrenderborder(ARegion *ar, View3D *v3d);
342 void VP_view3d_draw_background_none(void);
343 void VP_view3d_draw_background_world(Scene *scene, View3D *v3d, RegionView3D *rv3d);
344
345 #endif /* __VIEW3D_INTERN_H__ */