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