Workspace: Move engines to workspace and Properties Editor cleanup
[blender.git] / source / blender / makesdna / DNA_workspace_types.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 DNA_workspace_types.h
22  *  \ingroup DNA
23  *
24  * Use API in BKE_workspace.h!
25  * Struct members marked with DNA_PRIVATE_WORKSPACE will throw a
26  * warning saying it's deprecated when used outside of workspace.c.
27  */
28
29 #ifndef __DNA_WORKSPACE_TYPES_H__
30 #define __DNA_WORKSPACE_TYPES_H__
31
32 #include "DNA_scene_types.h"
33
34 /* Same logic as DNA_DEPRECATED_ALLOW, but throws 'deprecated'
35  * warnings if DNA_PRIVATE_WORKSPACE_ALLOW is not defined */
36 #ifdef DNA_PRIVATE_WORKSPACE_ALLOW
37    /* allow use of private items */
38 #  define DNA_PRIVATE_WORKSPACE
39 #else
40 #  ifndef DNA_PRIVATE_WORKSPACE
41 #    define DNA_PRIVATE_WORKSPACE DNA_PRIVATE_ATTR
42 #  endif
43 #endif
44
45 #ifdef DNA_PRIVATE_READ_WRITE_ALLOW
46 #  define DNA_PRIVATE_WORKSPACE_READ_WRITE
47 #else
48 #  ifndef DNA_PRIVATE_WORKSPACE_READ_WRITE
49 #    define DNA_PRIVATE_WORKSPACE_READ_WRITE DNA_PRIVATE_WORKSPACE
50 #  endif
51 #endif
52
53
54 /**
55  * \brief Wrapper for bScreen.
56  *
57  * bScreens are IDs and thus stored in a main list-base. We also want to store a list-base of them within the
58  * workspace (so each workspace can have its own set of screen-layouts) which would mess with the next/prev pointers.
59  * So we use this struct to wrap a bScreen pointer with another pair of next/prev pointers.
60  */
61 typedef struct WorkSpaceLayout {
62         struct WorkSpaceLayout *next, *prev;
63
64         struct bScreen *screen DNA_PRIVATE_WORKSPACE;
65         /* The name of this layout, we override the RNA name of the screen with this (but not ID name itself) */
66         char name[64] DNA_PRIVATE_WORKSPACE; /* MAX_NAME */
67 } WorkSpaceLayout;
68
69 typedef struct WorkSpace {
70         ID id;
71
72         ListBase layouts DNA_PRIVATE_WORKSPACE; /* WorkSpaceLayout */
73         /* Store for each hook (so for each window) which layout has
74          * been activated the last time this workspace was visible. */
75         ListBase hook_layout_relations DNA_PRIVATE_WORKSPACE_READ_WRITE; /* WorkSpaceDataRelation */
76
77         /* Custom transform orientations */
78         ListBase transform_orientations DNA_PRIVATE_WORKSPACE;
79
80         int object_mode DNA_PRIVATE_WORKSPACE; /* enum ObjectMode */
81         int flags DNA_PRIVATE_WORKSPACE; /* enum eWorkSpaceFlags */
82
83         struct SceneLayer *render_layer DNA_PRIVATE_WORKSPACE;
84
85         char engine_id[32]; /* Render Engine. */
86         struct ViewRender view_render;
87 } WorkSpace;
88
89 /* internal struct, but exported for read/write */
90 #if defined(DNA_PRIVATE_READ_WRITE_ALLOW) || defined(DNA_PRIVATE_WORKSPACE_ALLOW)
91
92 /**
93  * Generic (and simple/primitive) struct for storing a history of assignments/relations
94  * of workspace data to non-workspace data in a listbase inside the workspace.
95  *
96  * Using this we can restore the old state of a workspace if the user switches back to it.
97  *
98  * Usage
99  * =====
100  * When activating a workspace, it should activate the screen-layout that was active in that
101  * workspace before *in this window*.
102  * More concretely:
103  * * There are two windows, win1 and win2.
104  * * Both show workspace ws1, but both also had workspace ws2 activated at some point before.
105  * * Last time ws2 was active in win1, screen-layout sl1 was activated.
106  * * Last time ws2 was active in win2, screen-layout sl2 was activated.
107  * * When changing from ws1 to ws2 in win1, screen-layout sl1 should be activated again.
108  * * When changing from ws1 to ws2 in win2, screen-layout sl2 should be activated again.
109  * So that means we have to store the active screen-layout in a per workspace, per window
110  * relation. This struct is used to store an active screen-layout for each window within the
111  * workspace.
112  * To find the screen-layout to activate for this window-workspace combination, simply lookup
113  * the WorkSpaceDataRelation with the workspace-hook of the window set as parent.
114  */
115 typedef struct WorkSpaceDataRelation {
116         struct WorkSpaceDataRelation *next, *prev;
117
118         /* the data used to identify the relation (e.g. to find screen-layout (= value) from/for a hook) */
119         void *parent;
120         /* The value for this parent-data/workspace relation */
121         void *value;
122 } WorkSpaceDataRelation;
123
124 #endif /* DNA_PRIVATE_WORKSPACE_READ_WRITE */
125
126 /**
127  * Little wrapper to store data that is going to be per window, but comming from the workspace.
128  * It allows us to keep workspace and window data completely separate.
129  */
130 typedef struct WorkSpaceInstanceHook {
131         WorkSpace *active DNA_PRIVATE_WORKSPACE;
132         struct WorkSpaceLayout *act_layout DNA_PRIVATE_WORKSPACE;
133
134         /* Needed because we can't change workspaces/layouts in running handler loop, it would break context. */
135         WorkSpace *temp_workspace_store;
136         struct WorkSpaceLayout *temp_layout_store;
137 } WorkSpaceInstanceHook;
138
139 typedef enum eWorkSpaceFlags {
140         WORKSPACE_USE_SCENE_SETTINGS = (1 << 0),
141 } eWorkSpaceFlags;
142
143 #endif /* __DNA_WORKSPACE_TYPES_H__ */