Merge branch 'blender2.7'
[blender.git] / source / blender / windowmanager / WM_toolsystem.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 #ifndef __WM_TOOLSYSTEM_H__
17 #define __WM_TOOLSYSTEM_H__
18
19 /** \file blender/windowmanager/WM_toolsystem.h
20  *  \ingroup wm
21  */
22
23 /* dna-savable wmStructs here */
24 #include "BLI_compiler_attrs.h"
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 struct IDProperty;
31 struct Main;
32 struct PointerRNA;
33 struct ScrArea;
34 struct StructRNA;
35 struct WorkSpace;
36 struct bContext;
37 struct bToolRef_Runtime;
38 struct wmMsgSubscribeKey;
39 struct wmMsgSubscribeValue;
40 struct wmOperatorType;
41
42 /* wm_toolsystem.c  */
43
44 #define WM_TOOLSYSTEM_SPACE_MASK ( \
45         (1 << SPACE_IMAGE) | \
46         (1 << SPACE_NODE) | \
47         (1 << SPACE_VIEW3D) )
48
49 /* Values that define a categoey of active tool. */
50 typedef struct bToolKey { int space_type; int mode; } bToolKey;
51
52 struct bToolRef *WM_toolsystem_ref_from_context(struct bContext *C);
53 struct bToolRef *WM_toolsystem_ref_find(struct WorkSpace *workspace, const bToolKey *tkey);
54 bool WM_toolsystem_ref_ensure(
55         struct WorkSpace *workspace, const bToolKey *tkey,
56         struct bToolRef **r_tref);
57 struct bToolRef *WM_toolsystem_ref_set_by_name(
58         struct bContext *C, struct WorkSpace *workspace, const bToolKey *tkey,
59         const char *name, bool cycle);
60
61 struct bToolRef_Runtime *WM_toolsystem_runtime_from_context(struct bContext *C);
62 struct bToolRef_Runtime *WM_toolsystem_runtime_find(struct WorkSpace *workspace, const bToolKey *tkey);
63
64 void WM_toolsystem_unlink(struct bContext *C, struct WorkSpace *workspace, const bToolKey *tkey);
65 void WM_toolsystem_refresh(struct bContext *C, struct WorkSpace *workspace, const bToolKey *tkey);
66 void WM_toolsystem_reinit(struct bContext *C, struct WorkSpace *workspace, const bToolKey *tkey);
67
68 void WM_toolsystem_unlink_all(struct bContext *C, struct WorkSpace *workspace);
69 void WM_toolsystem_refresh_all(struct bContext *C, struct WorkSpace *workspace);
70 void WM_toolsystem_reinit_all(struct bContext *C, struct wmWindow *win);
71
72 void WM_toolsystem_ref_set_from_runtime(
73         struct bContext *C, struct WorkSpace *workspace, struct bToolRef *tref,
74         const struct bToolRef_Runtime *tool, const char *idname);
75
76 void WM_toolsystem_ref_sync_from_context(
77         struct Main *bmain, struct WorkSpace *workspace, struct bToolRef *tref);
78
79 void WM_toolsystem_init(struct bContext *C);
80
81 int WM_toolsystem_mode_from_spacetype(
82         struct ViewLayer *view_layer, struct ScrArea *sa, int space_type);
83 bool WM_toolsystem_key_from_context(
84         struct ViewLayer *view_layer, struct ScrArea *sa, bToolKey *tkey);
85
86 void WM_toolsystem_update_from_context_view3d(struct bContext *C);
87 void WM_toolsystem_update_from_context(
88         struct bContext *C, struct WorkSpace *workspace, struct ViewLayer *view_layer,
89         struct ScrArea *sa);
90
91 bool WM_toolsystem_active_tool_is_brush(const struct bContext *C);
92
93 void WM_toolsystem_do_msg_notify_tag_refresh(
94         struct bContext *C, struct wmMsgSubscribeKey *msg_key, struct wmMsgSubscribeValue *msg_val);
95
96 struct IDProperty *WM_toolsystem_ref_properties_ensure_idprops(struct bToolRef *tref);
97 void WM_toolsystem_ref_properties_ensure_ex(
98         struct bToolRef *tref, const char *idname, struct StructRNA *type, struct PointerRNA *r_ptr);
99
100 #define WM_toolsystem_ref_properties_ensure_from_operator(tref, ot, r_ptr) \
101         WM_toolsystem_ref_properties_ensure_ex(tref, (ot)->idname, (ot)->srna, r_ptr)
102 #define WM_toolsystem_ref_properties_ensure_from_gizmo_group(tref, gzgroup, r_ptr) \
103         WM_toolsystem_ref_properties_ensure_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)
104
105 bool WM_toolsystem_ref_properties_get_ex(
106         struct bToolRef *tref, const char *idname, struct StructRNA *type, struct PointerRNA *r_ptr);
107 #define WM_toolsystem_ref_properties_get_from_operator(tref, ot, r_ptr) \
108         WM_toolsystem_ref_properties_get_ex(tref, (ot)->idname, (ot)->srna, r_ptr)
109 #define WM_toolsystem_ref_properties_get_from_gizmo_group(tref, gzgroup, r_ptr) \
110         WM_toolsystem_ref_properties_get_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)
111
112 void WM_toolsystem_ref_properties_init_for_keymap(
113         struct bToolRef *tref, struct PointerRNA *dst_ptr, struct PointerRNA *src_ptr, struct wmOperatorType *ot);
114
115 void WM_toolsystem_refresh_active(struct bContext *C);
116
117 void WM_toolsystem_refresh_screen_area(struct WorkSpace *workspace, struct ViewLayer *view_layer, struct ScrArea *sa);
118 void WM_toolsystem_refresh_screen_all(struct Main *bmain);
119
120 #ifdef __cplusplus
121 }
122 #endif
123
124 #endif /* __WM_TOOLSYSTEM_API_H__ */