Merge branch 'blender2.7'
[blender.git] / source / blender / depsgraph / intern / depsgraph_type.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file blender/depsgraph/intern/depsgraph_type.h
21  *  \ingroup depsgraph
22  *
23  * Datatypes for internal use in the Depsgraph
24  *
25  * All of these datatypes are only really used within the "core" depsgraph.
26  * In particular, node types declared here form the structure of operations
27  * in the graph.
28  */
29
30 #pragma once
31
32 #include <functional>
33
34 /* TODO(sergey): Ideally we'll just use char* and statically allocated strings
35  * to avoid any possible overhead caused by string (re)allocation/formatting. */
36 #include <string>
37 #include <vector>
38 #include <algorithm>
39
40 struct Depsgraph;
41
42 namespace DEG {
43
44 /* Commonly used types. */
45 using std::string;
46 using std::vector;
47
48 /* Commonly used functions. */
49 using std::max;
50 using std::to_string;
51
52 /* Function bindings. */
53 using std::function;
54 using namespace std::placeholders;
55 #define function_bind std::bind
56
57 /* Source of the dependency graph node update tag.
58  *
59  * NOTE: This is a bit mask, so accumulation of sources is possible.
60  *
61  * TODO(sergey): Find a better place for this. */
62 enum eUpdateSource {
63         /* Update is caused by a time change. */
64         DEG_UPDATE_SOURCE_TIME       = (1 << 0),
65         /* Update caused by user directly or indirectly influencing the node. */
66         DEG_UPDATE_SOURCE_USER_EDIT  = (1 << 1),
67         /* Update is happening as a special response for the relations update. */
68         DEG_UPDATE_SOURCE_RELATIONS  = (1 << 2),
69         /* Update is happening due to visibility change. */
70         DEG_UPDATE_SOURCE_VISIBILITY = (1 << 3),
71 };
72
73 }  // namespace DEG