Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_pchanmap.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) 2015 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup depsgraph
21  */
22
23 #pragma once
24
25 struct GHash;
26
27 namespace DEG {
28
29 struct RootPChanMap {
30         /* ctor and dtor - Create and free the internal map respectively. */
31         RootPChanMap();
32         ~RootPChanMap();
33
34         /* Debug contents of map. */
35         void print_debug();
36
37         /* Add a mapping. */
38         void add_bone(const char *bone, const char *root);
39
40         /* Check if there's a common root bone between two bones. */
41         bool has_common_root(const char *bone1, const char *bone2);
42
43 protected:
44         /* The actual map:
45          * - Keys are "strings" (const char *) - not dynamically allocated.
46          * - Values are "sets" (const char *) - not dynamically allocated.
47          *
48          * We don't use the C++ maps here, as it's more convenient to use
49          * Blender's GHash and be able to compare by-value instead of by-ref. */
50         struct GHash *map_;
51 };
52
53 }  // namespace DEG