Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_map.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) 2018 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup depsgraph
21  */
22
23 #pragma once
24
25 struct GSet;
26 struct ID;
27
28 namespace DEG {
29
30 class BuilderMap {
31 public:
32         BuilderMap();
33         ~BuilderMap();
34
35         /* Check whether given ID is already handled by builder (or if it's being
36          * handled). */
37         bool checkIsBuilt(ID *id);
38
39         /* Tag given ID as handled/built. */
40         void tagBuild(ID *id);
41
42         /* Combination of previous two functions, returns truth if ID was already
43          * handled, or tags is handled otherwise and return false. */
44         bool checkIsBuiltAndTag(ID *id);
45
46         template<typename T> bool checkIsBuilt(T *datablock) {
47                 return checkIsBuilt(&datablock->id);
48         }
49         template<typename T> void tagBuild(T *datablock) {
50                 tagBuild(&datablock->id);
51         }
52         template<typename T> bool checkIsBuiltAndTag(T *datablock) {
53                 return checkIsBuiltAndTag(&datablock->id);
54         }
55
56         GSet *set;
57 };
58
59 }  // namespace DEG