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