Depsgraph: Comb code to a better state all over
[blender.git] / source / blender / depsgraph / intern / depsgraph_type.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  * The Original Code is Copyright (C) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/depsgraph_type.h
28  *  \ingroup depsgraph
29  *
30  * Datatypes for internal use in the Depsgraph
31  *
32  * All of these datatypes are only really used within the "core" depsgraph.
33  * In particular, node types declared here form the structure of operations
34  * in the graph.
35  */
36
37 #pragma once
38
39 #include <functional>
40
41 /* TODO(sergey): Ideally we'll just use char* and statically allocated strings
42  * to avoid any possible overhead caused by string (re)allocation/formatting. */
43 #include <string>
44 #include <vector>
45 #include <algorithm>
46
47 struct Depsgraph;
48
49 namespace DEG {
50
51 /* Commonly used types. */
52 using std::string;
53 using std::vector;
54
55 /* Commonly used functions. */
56 using std::max;
57 using std::to_string;
58
59 /* Function bindings. */
60 using std::function;
61 using namespace std::placeholders;
62 #define function_bind std::bind
63
64 /* Source of the dependency graph node update tag.
65  *
66  * NOTE: This is a bit mask, so accumulation of sources is possible.
67  *
68  * TODO(sergey): Find a better place for this. */
69 enum eUpdateSource {
70         /* Update is caused by a time change. */
71         DEG_UPDATE_SOURCE_TIME       = (1 << 0),
72         /* Update caused by user directly or indirectly influencing the node. */
73         DEG_UPDATE_SOURCE_USER_EDIT  = (1 << 1),
74         /* Update is happening as a special response for the relations update. */
75         DEG_UPDATE_SOURCE_RELATIONS  = (1 << 2),
76         /* Update is happening due to visibility change. */
77         DEG_UPDATE_SOURCE_VISIBILITY = (1 << 3),
78 };
79
80 }  // namespace DEG