Differential D2451 Diff 8748 source/blender/makesdna/dna_workspace_types.h

Changeset View

Standalone View

source/blender/makesdna/dna_workspace_types.h

This file was added.

				/*
				* *** BEGIN GPL LICENSE BLOCK ***
				*
				* This program is free software; you can redistribute it and/or
				* modify it under the terms of the GNU General Public License
				* as published by the Free Software Foundation; either version 2
				* of the License, or (at your option) any later version.
				*
				* This program is distributed in the hope that it will be useful,
				* but WITHOUT ANY WARRANTY; without even the implied warranty of
				* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
				* GNU General Public License for more details.
				*
				* You should have received a copy of the GNU General Public License
				* along with this program; if not, write to the Free Software Foundation,
				* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
				*
				* *** END GPL LICENSE BLOCK ***
				*/

				/** \file dna_workspace_types.h
				* \ingroup DNA
				*
				* Only use with API in BKE_workspace.h!
				*/

				#ifndef __DNA_WORKSPACE_TYPES_H__
				#define __DNA_WORKSPACE_TYPES_H__

				#if !defined(NAMESPACE_WORKSPACE) && !defined(NAMESPACE_DNA)
				# error "This file shouldn't be included outside of workspace namespace."
				#endif

				/**
				* \brief Wrapper for bScreen.
				*
				* bScreens are IDs and thus stored in a main list-base. We also want to store a list-base of them within the
				* workspace (so each workspace can have its own set of screen-layouts) which would mess with the next/prev pointers.
				* So we use this struct to wrap a bScreen pointer with another pair of next/prev pointers.
				*/
				typedef struct WorkSpaceLayout {
				struct WorkSpaceLayout next, prev;

				struct bScreen *screen;
				/* The name of this layout, we override the RNA name of the screen with this (but not ID name itself) */
				char name[64]; /* MAX_NAME */
				} WorkSpaceLayout;

				typedef struct WorkSpace {
				ID id;

				ListBase layouts; /* WorkSpaceLayout */
				/* Store for each hook (so for each window) which layout has
				* been activated the last time this workspace was visible. */
				ListBase hook_layout_relations; /* WorkSpaceDataRelation */

				int object_mode; /* enum ObjectMode */
				int pad;

				struct SceneLayer *render_layer;
				} WorkSpace;

				/**
				* Generic (and simple/primitive) struct for storing a history of assignments/relations
				* of workspace data to non-workspace data in a listbase inside the workspace.
				*
				* Using this we can restore the old state of a workspace if the user switches back to it.
				*
				* Usage
				* =====
				* When activating a workspace, it should activate the screen-layout that was active in that
				* workspace before in this window.
				* More concretely:
				* * There are two windows, win1 and win2.
				* * Both show workspace ws1, but both also had workspace ws2 activated at some point before.
				* * Last time ws2 was active in win1, screen-layout sl1 was activated.
				* * Last time ws2 was active in win2, screen-layout sl2 was activated.
				* * When changing from ws1 to ws2 in win1, screen-layout sl1 should be activated again.
				* * When changing from ws1 to ws2 in win2, screen-layout sl2 should be activated again.
				* So that means we have to store the active screen-layout in a per workspace, per window
				* relation. This struct is used to store an active screen-layout for each window within the
				* workspace.
				* To find the screen-layout to activate for this window-workspace combination, simply lookup
				* the WorkSpaceDataRelation with the workspace-hook of the window set as parent.
				*/
				typedef struct WorkSpaceDataRelation {
				struct WorkSpaceDataRelation next, prev;

				/* the data used to identify the relation (e.g. to find screen-layout (= value) from/for a hook) */
				void *parent;
				/* The value for this parent-data/workspace relation */
				void *value;
				} WorkSpaceDataRelation;

				/**
				* Little wrapper to store data that is going to be per window, but comming from the workspace.
				* It allows us to keep workspace and window data completely separate.
				*/
				typedef struct WorkSpaceInstanceHook {
				WorkSpace *active;
				WorkSpace *temp_store;

				struct WorkSpaceLayout *act_layout;
				struct WorkSpaceLayout temp_layout_store; / temporary when switching screens */
				} WorkSpaceInstanceHook;

				#endif /* __DNA_WORKSPACE_TYPES_H__ */