Depsgraph: New dependency graph integration commit
[blender.git] / source / blender / depsgraph / util / depsgraph_util_pchanmap.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2015 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Sergey Sharybin
22  * Contributor(s): Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef ___DEPSGRAPH_UTIL_PCHANMAP_H__
28 #define ___DEPSGRAPH_UTIL_PCHANMAP_H__
29
30 struct RootPChanMap {
31         /* ctor and dtor - Create and free the internal map respectively. */
32         RootPChanMap();
33         ~RootPChanMap();
34
35         /* Debug contents of map. */
36         void print_debug();
37
38         /* Add a mapping. */
39         void add_bone(const char *bone, const char *root);
40
41         /* Check if there's a common root bone between two bones. */
42         bool has_common_root(const char *bone1, const char *bone2);
43
44 private:
45         /* The actual map:
46          * - Keys are "strings" (const char *) - not dynamically allocated.
47          * - Values are "sets" (const char *) - not dynamically allocated.
48          *
49          * We don't use the C++ maps here, as it's more convenient to use
50          * Blender's GHash and be able to compare by-value instead of by-ref.
51          */
52         struct GHash *m_map;
53 };
54
55 #endif  /* __DEPSGRAPH_UTIL_PCHANMAP_H__ */