Fix T53850: Lock to Cursor breaks 3D manipulators
[blender-staging.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 DerivedMesh;
42 struct Object;
43 struct SmokeDomainSettings;
44 struct bAnimVizSettings;
45 struct bContext;
46 struct bMotionPath;
47 struct bPoseChannel;
48 struct Mesh;
49 struct wmOperatorType;
50 struct wmWindowManager;
51 struct wmKeyConfig;
52
53 /* drawing flags: */
54 enum {
55         DRAW_PICKING     = (1 << 0),
56         DRAW_CONSTCOLOR  = (1 << 1),
57         DRAW_SCENESET    = (1 << 2)
58 };
59
60 /* draw_mesh_fancy/draw_mesh_textured draw_flags */
61 enum {
62         DRAW_MODIFIERS_PREVIEW  = (1 << 0),
63         DRAW_FACE_SELECT        = (1 << 1)
64 };
65
66 /* view3d_header.c */
67 void VIEW3D_OT_layers(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_viewnumpad(struct wmOperatorType *ot);
86 void VIEW3D_OT_view_selected(struct wmOperatorType *ot);
87 void VIEW3D_OT_view_lock_clear(struct wmOperatorType *ot);
88 void VIEW3D_OT_view_lock_to_active(struct wmOperatorType *ot);
89 void VIEW3D_OT_view_center_cursor(struct wmOperatorType *ot);
90 void VIEW3D_OT_view_center_pick(struct wmOperatorType *ot);
91 void VIEW3D_OT_view_center_camera(struct wmOperatorType *ot);
92 void VIEW3D_OT_view_center_lock(struct wmOperatorType *ot);
93 void VIEW3D_OT_view_pan(struct wmOperatorType *ot);
94 void VIEW3D_OT_view_persportho(struct wmOperatorType *ot);
95 void VIEW3D_OT_navigate(struct wmOperatorType *ot);
96 void VIEW3D_OT_background_image_add(struct wmOperatorType *ot);
97 void VIEW3D_OT_background_image_remove(struct wmOperatorType *ot);
98 void VIEW3D_OT_view_orbit(struct wmOperatorType *ot);
99 void VIEW3D_OT_view_roll(struct wmOperatorType *ot);
100 void VIEW3D_OT_clip_border(struct wmOperatorType *ot);
101 void VIEW3D_OT_cursor3d(struct wmOperatorType *ot);
102 void VIEW3D_OT_manipulator(struct wmOperatorType *ot);
103 void VIEW3D_OT_enable_manipulator(struct wmOperatorType *ot);
104 void VIEW3D_OT_render_border(struct wmOperatorType *ot);
105 void VIEW3D_OT_clear_render_border(struct wmOperatorType *ot);
106 void VIEW3D_OT_zoom_border(struct wmOperatorType *ot);
107 void VIEW3D_OT_toggle_render(struct wmOperatorType *ot);
108
109 void view3d_boxview_copy(ScrArea *sa, ARegion *ar);
110
111 void view3d_orbit_apply_dyn_ofs(
112         float r_ofs[3], const float ofs_old[3], const float viewquat_old[4],
113         const float viewquat_new[4], const float dyn_ofs[3]);
114
115 #ifdef WITH_INPUT_NDOF
116 struct wmNDOFMotionData;
117
118 void view3d_ndof_fly(
119         const struct wmNDOFMotionData *ndof,
120         struct View3D *v3d, struct RegionView3D *rv3d,
121         const bool use_precision, const short protectflag,
122         bool *r_has_translate, bool *r_has_rotate);
123 #endif /* WITH_INPUT_NDOF */
124
125 /* view3d_fly.c */
126 void view3d_keymap(struct wmKeyConfig *keyconf);
127 void VIEW3D_OT_fly(struct wmOperatorType *ot);
128
129 /* view3d_walk.c */
130 void VIEW3D_OT_walk(struct wmOperatorType *ot);
131
132 /* view3d_ruler.c */
133 void VIEW3D_OT_ruler(struct wmOperatorType *ot);
134
135 /* drawanim.c */
136 void draw_motion_paths_init(View3D *v3d, struct ARegion *ar);
137 void draw_motion_path_instance(Scene *scene,
138                                struct Object *ob, struct bPoseChannel *pchan,
139                                struct bAnimVizSettings *avs, struct bMotionPath *mpath);
140 void draw_motion_paths_cleanup(View3D *v3d);
141
142
143
144 /* drawobject.c */
145 void draw_object(Scene *scene, struct ARegion *ar, View3D *v3d, Base *base, const short dflag);
146 void draw_object_select(Scene *scene, ARegion *ar, View3D *v3d, Base *base, const short dflag);
147
148 bool draw_glsl_material(Scene *scene, struct Object *ob, View3D *v3d, const char dt);
149 void draw_object_instance(Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob, const char dt, int outline);
150 void draw_object_backbufsel(Scene *scene, View3D *v3d, RegionView3D *rv3d, struct Object *ob);
151 void drawaxes(const float viewmat_local[4][4], float size, char drawtype);
152
153 void view3d_cached_text_draw_begin(void);
154 void view3d_cached_text_draw_add(const float co[3],
155                                  const char *str, const size_t str_len,
156                                  short xoffs, short flag, const unsigned char col[4]);
157 void view3d_cached_text_draw_end(View3D *v3d, ARegion *ar, bool depth_write);
158
159 bool check_object_draw_texture(struct Scene *scene, struct View3D *v3d, const char drawtype);
160
161 enum {
162         V3D_CACHE_TEXT_ZBUF         = (1 << 0),
163         V3D_CACHE_TEXT_WORLDSPACE   = (1 << 1),
164         V3D_CACHE_TEXT_ASCII        = (1 << 2),
165         V3D_CACHE_TEXT_GLOBALSPACE  = (1 << 3),
166         V3D_CACHE_TEXT_LOCALCLIP    = (1 << 4)
167 };
168
169 int view3d_effective_drawtype(const struct View3D *v3d);
170
171 /* drawarmature.c */
172 bool draw_armature(Scene *scene, View3D *v3d, ARegion *ar, Base *base,
173                    const short dt, const short dflag, const unsigned char ob_wire_col[4],
174                    const bool is_outline);
175
176 /* drawmesh.c */
177 void draw_mesh_textured(Scene *scene, View3D *v3d, RegionView3D *rv3d,
178                         struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
179 void draw_mesh_face_select(
180         struct RegionView3D *rv3d, struct Mesh *me, struct DerivedMesh *dm,
181         bool draw_select_edges);
182 void draw_mesh_paint_weight_faces(struct DerivedMesh *dm, const bool do_light,
183                                   void *facemask_cb, void *user_data);
184 void draw_mesh_paint_vcolor_faces(struct DerivedMesh *dm, const bool use_light,
185                                   void *facemask_cb, void *user_data,
186                                   const struct Mesh *me);
187 void draw_mesh_paint_weight_edges(RegionView3D *rv3d, struct DerivedMesh *dm,
188                                   const bool use_depth, const bool use_alpha,
189                                   void *edgemask_cb, void *user_data);
190 void draw_mesh_paint(View3D *v3d, RegionView3D *rv3d,
191                      struct Object *ob, struct DerivedMesh *dm, const int draw_flags);
192
193 /* drawsimdebug.c */
194 void draw_sim_debug_data(Scene *scene, View3D *v3d, ARegion *ar);
195
196 /* view3d_draw.c */
197 void view3d_main_region_draw(const struct bContext *C, struct ARegion *ar);
198 void ED_view3d_draw_depth(Scene *scene, struct ARegion *ar, View3D *v3d, bool alphaoverride);
199 void ED_view3d_draw_depth_gpencil(Scene *scene, ARegion *ar, View3D *v3d);
200 void ED_view3d_draw_select_loop(
201         ViewContext *vc, Scene *scene, View3D *v3d, ARegion *ar,
202         bool use_obedit_skip, bool use_nearest);
203
204 void ED_view3d_after_add(ListBase *lb, Base *base, const short dflag);\
205
206 void circf(float x, float y, float rad);
207 void circ(float x, float y, float rad);
208 void view3d_update_depths_rect(struct ARegion *ar, struct ViewDepths *d, struct rcti *rect);
209 float view3d_depth_near(struct ViewDepths *d);
210
211 /* view3d_select.c */
212 void VIEW3D_OT_select(struct wmOperatorType *ot);
213 void VIEW3D_OT_select_circle(struct wmOperatorType *ot);
214 void VIEW3D_OT_select_border(struct wmOperatorType *ot);
215 void VIEW3D_OT_select_lasso(struct wmOperatorType *ot);
216 void VIEW3D_OT_select_menu(struct wmOperatorType *ot);
217
218 void VIEW3D_OT_smoothview(struct wmOperatorType *ot);
219 void VIEW3D_OT_camera_to_view(struct wmOperatorType *ot);
220 void VIEW3D_OT_camera_to_view_selected(struct wmOperatorType *ot);
221 void VIEW3D_OT_object_as_camera(struct wmOperatorType *ot);
222 void VIEW3D_OT_localview(struct wmOperatorType *ot);
223 void VIEW3D_OT_game_start(struct wmOperatorType *ot);
224
225
226 bool ED_view3d_boundbox_clip_ex(const RegionView3D *rv3d, const struct BoundBox *bb, float obmat[4][4]);
227 bool ED_view3d_boundbox_clip(RegionView3D *rv3d, const struct BoundBox *bb);
228
229 typedef struct V3D_SmoothParams {
230         struct Object *camera_old, *camera;
231         const float *ofs, *quat, *dist, *lens;
232         /* alternate rotation center (ofs = must be NULL) */
233         const float *dyn_ofs;
234 } V3D_SmoothParams;
235
236 void ED_view3d_smooth_view_ex(
237         struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa,
238         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
239         const V3D_SmoothParams *sview);
240
241 void ED_view3d_smooth_view(
242         struct bContext *C,
243         struct View3D *v3d, struct ARegion *ar, const int smooth_viewtx,
244         const V3D_SmoothParams *sview);
245
246 void ED_view3d_smooth_view_force_finish(
247         struct bContext *C,
248         struct View3D *v3d, struct ARegion *ar);
249
250 void view3d_winmatrix_set(ARegion *ar, const View3D *v3d, const rcti *rect);
251 void view3d_viewmatrix_set(Scene *scene, const View3D *v3d, RegionView3D *rv3d, const float rect_scale[2]);
252
253 void fly_modal_keymap(struct wmKeyConfig *keyconf);
254 void walk_modal_keymap(struct wmKeyConfig *keyconf);
255 void viewrotate_modal_keymap(struct wmKeyConfig *keyconf);
256 void viewmove_modal_keymap(struct wmKeyConfig *keyconf);
257 void viewzoom_modal_keymap(struct wmKeyConfig *keyconf);
258 void viewdolly_modal_keymap(struct wmKeyConfig *keyconf);
259
260 /* view3d_buttons.c */
261 void VIEW3D_OT_properties(struct wmOperatorType *ot);
262 void view3d_buttons_register(struct ARegionType *art);
263
264 /* view3d_camera_control.c */
265 struct View3DCameraControl *ED_view3d_cameracontrol_acquire(
266         Scene *scene, View3D *v3d, RegionView3D *rv3d,
267         const bool use_parent_root);
268 void ED_view3d_cameracontrol_update(
269         struct View3DCameraControl *vctrl,
270         const bool use_autokey,
271         struct bContext *C, const bool do_rotate, const bool do_translate);
272 void ED_view3d_cameracontrol_release(
273         struct View3DCameraControl *vctrl,
274         const bool restore);
275 Object *ED_view3d_cameracontrol_object_get(
276         struct View3DCameraControl *vctrl);
277
278 /* view3d_toolbar.c */
279 void VIEW3D_OT_toolshelf(struct wmOperatorType *ot);
280 void view3d_toolshelf_register(struct ARegionType *art);
281 void view3d_tool_props_register(struct ARegionType *art);
282
283 /* view3d_snap.c */
284 bool ED_view3d_minmax_verts(struct Object *obedit, float min[3], float max[3]);
285
286 void VIEW3D_OT_snap_selected_to_grid(struct wmOperatorType *ot);
287 void VIEW3D_OT_snap_selected_to_cursor(struct wmOperatorType *ot);
288 void VIEW3D_OT_snap_selected_to_active(struct wmOperatorType *ot);
289 void VIEW3D_OT_snap_cursor_to_grid(struct wmOperatorType *ot);
290 void VIEW3D_OT_snap_cursor_to_center(struct wmOperatorType *ot);
291 void VIEW3D_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
292 void VIEW3D_OT_snap_cursor_to_active(struct wmOperatorType *ot);
293
294 /* space_view3d.c */
295 ARegion *view3d_has_buttons_region(ScrArea *sa);
296 ARegion *view3d_has_tools_region(ScrArea *sa);
297
298 extern const char *view3d_context_dir[]; /* doc access */
299
300 /* draw_volume.c */
301 void draw_smoke_volume(struct SmokeDomainSettings *sds, struct Object *ob,
302                        const float min[3], const float max[3],
303                        const float viewnormal[3]);
304
305 void draw_smoke_velocity(struct SmokeDomainSettings *domain, float viewnormal[3]);
306
307 /* workaround for trivial but noticeable camera bug caused by imprecision
308  * between view border calculation in 2D/3D space, workaround for bug [#28037].
309  * without this define we get the old behavior which is to try and align them
310  * both which _mostly_ works fine, but when the camera moves beyond ~1000 in
311  * any direction it starts to fail */
312 #define VIEW3D_CAMERA_BORDER_HACK
313 #ifdef VIEW3D_CAMERA_BORDER_HACK
314 extern unsigned char view3d_camera_border_hack_col[3];
315 extern bool view3d_camera_border_hack_test;
316 #endif
317
318 #endif /* __VIEW3D_INTERN_H__ */
319