Rename any instance of scene layer or render layer in code with view layer
[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 /* Currently testing, allow to disable. */
54 #define USE_WORKSPACE_TOOL
55
56 typedef struct bToolDef {
57         /* either the keymap AND/OR manipulator_group must be defined. */
58         char keymap[64];
59         char manipulator_group[64];
60         int  spacetype;
61         /* index when a tool is a member of a group */
62         int  index;
63 } bToolDef;
64
65 /**
66  * \brief Wrapper for bScreen.
67  *
68  * bScreens are IDs and thus stored in a main list-base. We also want to store a list-base of them within the
69  * workspace (so each workspace can have its own set of screen-layouts) which would mess with the next/prev pointers.
70  * So we use this struct to wrap a bScreen pointer with another pair of next/prev pointers.
71  */
72 typedef struct WorkSpaceLayout {
73         struct WorkSpaceLayout *next, *prev;
74
75         struct bScreen *screen DNA_PRIVATE_WORKSPACE;
76         /* The name of this layout, we override the RNA name of the screen with this (but not ID name itself) */
77         char name[64] DNA_PRIVATE_WORKSPACE; /* MAX_NAME */
78 } WorkSpaceLayout;
79
80 typedef struct WorkSpace {
81         ID id;
82
83         ListBase layouts DNA_PRIVATE_WORKSPACE; /* WorkSpaceLayout */
84         /* Store for each hook (so for each window) which layout has
85          * been activated the last time this workspace was visible. */
86         ListBase hook_layout_relations DNA_PRIVATE_WORKSPACE_READ_WRITE; /* WorkSpaceDataRelation */
87
88         /* Custom transform orientations */
89         ListBase transform_orientations DNA_PRIVATE_WORKSPACE;
90
91         int object_mode DNA_PRIVATE_WORKSPACE; /* enum eObjectMode */
92         int flags DNA_PRIVATE_WORKSPACE; /* enum eWorkSpaceFlags */
93
94         /* should be: '#ifdef USE_WORKSPACE_TOOL'. */
95         bToolDef tool;
96
97         struct ViewLayer *view_layer DNA_PRIVATE_WORKSPACE;
98         struct ViewRender view_render;
99 } WorkSpace;
100
101 /* internal struct, but exported for read/write */
102 #if defined(DNA_PRIVATE_READ_WRITE_ALLOW) || defined(DNA_PRIVATE_WORKSPACE_ALLOW)
103
104 /**
105  * Generic (and simple/primitive) struct for storing a history of assignments/relations
106  * of workspace data to non-workspace data in a listbase inside the workspace.
107  *
108  * Using this we can restore the old state of a workspace if the user switches back to it.
109  *
110  * Usage
111  * =====
112  * When activating a workspace, it should activate the screen-layout that was active in that
113  * workspace before *in this window*.
114  * More concretely:
115  * * There are two windows, win1 and win2.
116  * * Both show workspace ws1, but both also had workspace ws2 activated at some point before.
117  * * Last time ws2 was active in win1, screen-layout sl1 was activated.
118  * * Last time ws2 was active in win2, screen-layout sl2 was activated.
119  * * When changing from ws1 to ws2 in win1, screen-layout sl1 should be activated again.
120  * * When changing from ws1 to ws2 in win2, screen-layout sl2 should be activated again.
121  * So that means we have to store the active screen-layout in a per workspace, per window
122  * relation. This struct is used to store an active screen-layout for each window within the
123  * workspace.
124  * To find the screen-layout to activate for this window-workspace combination, simply lookup
125  * the WorkSpaceDataRelation with the workspace-hook of the window set as parent.
126  */
127 typedef struct WorkSpaceDataRelation {
128         struct WorkSpaceDataRelation *next, *prev;
129
130         /* the data used to identify the relation (e.g. to find screen-layout (= value) from/for a hook) */
131         void *parent;
132         /* The value for this parent-data/workspace relation */
133         void *value;
134 } WorkSpaceDataRelation;
135
136 #endif /* DNA_PRIVATE_WORKSPACE_READ_WRITE */
137
138 /**
139  * Little wrapper to store data that is going to be per window, but comming from the workspace.
140  * It allows us to keep workspace and window data completely separate.
141  */
142 typedef struct WorkSpaceInstanceHook {
143         WorkSpace *active DNA_PRIVATE_WORKSPACE;
144         struct WorkSpaceLayout *act_layout DNA_PRIVATE_WORKSPACE;
145
146         /* Needed because we can't change workspaces/layouts in running handler loop, it would break context. */
147         WorkSpace *temp_workspace_store;
148         struct WorkSpaceLayout *temp_layout_store;
149 } WorkSpaceInstanceHook;
150
151 typedef enum eWorkSpaceFlags {
152         WORKSPACE_USE_SCENE_SETTINGS = (1 << 0),
153 } eWorkSpaceFlags;
154
155 #endif /* __DNA_WORKSPACE_TYPES_H__ */