Workspace: Move engines to workspace and Properties Editor cleanup
[blender.git] / source / blender / blenkernel / BKE_workspace.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file BKE_workspace.h
22  *  \ingroup bke
23  */
24
25 #ifndef __BKE_WORKSPACE_H__
26 #define __BKE_WORKSPACE_H__
27
28 #include "BLI_compiler_attrs.h"
29
30 struct bScreen;
31 struct TransformOrientation;
32
33 /**
34  * Plan is to store the object-mode per workspace, not per object anymore.
35  * However, there's quite some work to be done for that, so for now, there is just a basic
36  * implementation of an object <-> workspace object-mode syncing for testing, with some known
37  * problems. Main problem being that the modes can get out of sync when changing object selection.
38  * Would require a pile of temporary changes to always sync modes when changing selection. So just
39  * leaving this here for some testing until object-mode is really a workspace level setting.
40  */
41 #define USE_WORKSPACE_MODE
42
43
44 /* -------------------------------------------------------------------- */
45 /* Create, delete, init */
46
47 struct WorkSpace *BKE_workspace_add(struct Main *bmain, const char *name);
48 void BKE_workspace_free(struct WorkSpace *workspace);
49 void BKE_workspace_remove(struct Main *bmain, struct WorkSpace *workspace);
50
51 struct WorkSpaceInstanceHook *BKE_workspace_instance_hook_create(const struct Main *bmain);
52 void BKE_workspace_instance_hook_free(const struct Main *bmain, struct WorkSpaceInstanceHook *hook);
53
54 struct WorkSpaceLayout *BKE_workspace_layout_add(
55         struct WorkSpace *workspace,
56         struct bScreen *screen,
57         const char *name) ATTR_NONNULL();
58 void BKE_workspace_layout_remove(
59         struct Main *bmain,
60         struct WorkSpace *workspace, struct WorkSpaceLayout *layout) ATTR_NONNULL();
61
62
63 /* -------------------------------------------------------------------- */
64 /* General Utils */
65
66 void BKE_workspace_transform_orientation_remove(
67         struct WorkSpace *workspace, struct TransformOrientation *orientation) ATTR_NONNULL();
68 struct TransformOrientation *BKE_workspace_transform_orientation_find(
69         const struct WorkSpace *workspace, const int index) ATTR_NONNULL();
70 int BKE_workspace_transform_orientation_get_index(
71         const struct WorkSpace *workspace, const struct TransformOrientation *orientation) ATTR_NONNULL();
72
73 struct WorkSpaceLayout *BKE_workspace_layout_find(
74         const struct WorkSpace *workspace, const struct bScreen *screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
75 struct WorkSpaceLayout *BKE_workspace_layout_find_global(
76         const struct Main *bmain, const struct bScreen *screen,
77         struct WorkSpace **r_workspace) ATTR_NONNULL(1, 2);
78
79 struct WorkSpaceLayout *BKE_workspace_layout_iter_circular(
80         const struct WorkSpace *workspace, struct WorkSpaceLayout *start,
81         bool (*callback)(const struct WorkSpaceLayout *layout, void *arg),
82         void *arg, const bool iter_backward);
83
84
85 /* -------------------------------------------------------------------- */
86 /* Getters/Setters */
87
88 #define GETTER_ATTRS ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
89 #define SETTER_ATTRS ATTR_NONNULL(1)
90
91 struct WorkSpace *BKE_workspace_active_get(struct WorkSpaceInstanceHook *hook) GETTER_ATTRS;
92 void       BKE_workspace_active_set(struct WorkSpaceInstanceHook *hook, struct WorkSpace *workspace) SETTER_ATTRS;
93 struct WorkSpaceLayout *BKE_workspace_active_layout_get(const struct WorkSpaceInstanceHook *hook) GETTER_ATTRS;
94 void             BKE_workspace_active_layout_set(struct WorkSpaceInstanceHook *hook, struct WorkSpaceLayout *layout) SETTER_ATTRS;
95 struct bScreen *BKE_workspace_active_screen_get(const struct WorkSpaceInstanceHook *hook) GETTER_ATTRS;
96 void            BKE_workspace_active_screen_set(
97         struct WorkSpaceInstanceHook *hook, struct WorkSpace *workspace, struct bScreen *screen) SETTER_ATTRS;
98 enum ObjectMode BKE_workspace_object_mode_get(const struct WorkSpace *workspace) GETTER_ATTRS;
99 #ifdef USE_WORKSPACE_MODE
100 void            BKE_workspace_object_mode_set(struct WorkSpace *workspace, const enum ObjectMode mode) SETTER_ATTRS;
101 #endif
102 struct ListBase *BKE_workspace_transform_orientations_get(struct WorkSpace *workspace) GETTER_ATTRS;
103 struct SceneLayer *BKE_workspace_render_layer_get(const struct WorkSpace *workspace) GETTER_ATTRS;
104 void               BKE_workspace_render_layer_set(struct WorkSpace *workspace, struct SceneLayer *layer) SETTER_ATTRS;
105 struct ListBase *BKE_workspace_layouts_get(struct WorkSpace *workspace) GETTER_ATTRS;
106
107 const char *BKE_workspace_layout_name_get(const struct WorkSpaceLayout *layout) GETTER_ATTRS;
108 void        BKE_workspace_layout_name_set(
109         struct WorkSpace *workspace, struct WorkSpaceLayout *layout, const char *new_name) ATTR_NONNULL();
110 struct bScreen *BKE_workspace_layout_screen_get(const struct WorkSpaceLayout *layout) GETTER_ATTRS;
111 void            BKE_workspace_layout_screen_set(struct WorkSpaceLayout *layout, struct bScreen *screen) SETTER_ATTRS;
112
113 struct WorkSpaceLayout *BKE_workspace_hook_layout_for_workspace_get(
114         const struct WorkSpaceInstanceHook *hook, const struct WorkSpace *workspace) GETTER_ATTRS;
115 void             BKE_workspace_hook_layout_for_workspace_set(
116         struct WorkSpaceInstanceHook *hook, struct WorkSpace *workspace, struct WorkSpaceLayout *layout) ATTR_NONNULL();
117
118 struct ViewRender *BKE_workspace_view_render_get(struct WorkSpace *workspace) GETTER_ATTRS;
119
120 /* flags */
121 bool BKE_workspace_use_scene_settings_get(const struct WorkSpace *workspace) GETTER_ATTRS;
122 void BKE_workspace_use_scene_settings_set(struct WorkSpace *workspace, bool value) SETTER_ATTRS;
123
124 #undef GETTER_ATTRS
125 #undef SETTER_ATTRS
126
127 #endif /* __BKE_WORKSPACE_H__ */