97208939e5749752918880c2d14af7d02ff299c9
[blender-staging.git] / source / blender / depsgraph / intern / depsgraph_type_defines.cc
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) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/depsgraph_type_defines.cc
28  *  \ingroup depsgraph
29  *
30  * Defines and code for core node types.
31  */
32
33 #include <cstdlib>  // for BLI_assert()
34
35 extern "C" {
36 #include "BLI_utildefines.h"
37 #include "BLI_ghash.h"
38
39 #include "DEG_depsgraph.h"
40 } /* extern "C" */
41
42 #include "intern/nodes/deg_node.h"
43 #include "intern/nodes/deg_node_component.h"
44 #include "intern/nodes/deg_node_operation.h"
45
46 #include "intern/depsgraph_intern.h"
47
48 namespace DEG {
49
50 /* ************ */
51 /* External API */
52
53 /* Global type registry */
54
55 /**
56  * \note For now, this is a hashtable not array, since the core node types
57  * currently do not have contiguous ID values. Using a hash here gives us
58  * more flexibility, albeit using more memory and also sacrificing a little
59  * speed. Later on, when things stabilise we may turn this back to an array
60  * since there are only just a few node types that an array would cope fine...
61  */
62 static GHash *_depsnode_typeinfo_registry = NULL;
63
64 /* Registration ------------------------------------------- */
65
66 /* Register node type */
67 void deg_register_node_typeinfo(DepsNodeFactory *factory)
68 {
69         BLI_assert(factory != NULL);
70         BLI_ghash_insert(_depsnode_typeinfo_registry, SET_INT_IN_POINTER(factory->type()), factory);
71 }
72
73 /* Getters ------------------------------------------------- */
74
75 /* Get typeinfo for specified type */
76 DepsNodeFactory *deg_get_node_factory(const eDepsNode_Type type)
77 {
78         /* look up type - at worst, it doesn't exist in table yet, and we fail */
79         return (DepsNodeFactory *)BLI_ghash_lookup(_depsnode_typeinfo_registry, SET_INT_IN_POINTER(type));
80 }
81
82 /* Get typeinfo for provided node */
83 DepsNodeFactory *deg_node_get_factory(const DepsNode *node)
84 {
85         if (node != NULL) {
86                 return NULL;
87         }
88         return deg_get_node_factory(node->type);
89 }
90
91 /* Stringified opcodes ------------------------------------- */
92
93 DepsOperationStringifier DEG_OPNAMES;
94
95 static const char *stringify_opcode(eDepsOperation_Code opcode)
96 {
97         switch (opcode) {
98 #define STRINGIFY_OPCODE(name) case DEG_OPCODE_##name: return #name
99                 STRINGIFY_OPCODE(OPERATION);
100                 STRINGIFY_OPCODE(PLACEHOLDER);
101                 STRINGIFY_OPCODE(NOOP);
102                 STRINGIFY_OPCODE(ANIMATION);
103                 STRINGIFY_OPCODE(DRIVER);
104                 //STRINGIFY_OPCODE(PROXY);
105                 STRINGIFY_OPCODE(TRANSFORM_LOCAL);
106                 STRINGIFY_OPCODE(TRANSFORM_PARENT);
107                 STRINGIFY_OPCODE(TRANSFORM_CONSTRAINTS);
108                 //STRINGIFY_OPCODE(TRANSFORM_CONSTRAINTS_INIT);
109                 //STRINGIFY_OPCODE(TRANSFORM_CONSTRAINT);
110                 //STRINGIFY_OPCODE(TRANSFORM_CONSTRAINTS_DONE);
111                 STRINGIFY_OPCODE(RIGIDBODY_REBUILD);
112                 STRINGIFY_OPCODE(RIGIDBODY_SIM);
113                 STRINGIFY_OPCODE(TRANSFORM_RIGIDBODY);
114                 STRINGIFY_OPCODE(TRANSFORM_FINAL);
115                 STRINGIFY_OPCODE(OBJECT_UBEREVAL);
116                 STRINGIFY_OPCODE(GEOMETRY_UBEREVAL);
117                 STRINGIFY_OPCODE(GEOMETRY_MODIFIER);
118                 STRINGIFY_OPCODE(GEOMETRY_PATH);
119                 STRINGIFY_OPCODE(POSE_INIT);
120                 STRINGIFY_OPCODE(POSE_DONE);
121                 STRINGIFY_OPCODE(POSE_IK_SOLVER);
122                 STRINGIFY_OPCODE(POSE_SPLINE_IK_SOLVER);
123                 STRINGIFY_OPCODE(BONE_LOCAL);
124                 STRINGIFY_OPCODE(BONE_POSE_PARENT);
125                 STRINGIFY_OPCODE(BONE_CONSTRAINTS);
126                 //STRINGIFY_OPCODE(BONE_CONSTRAINTS_INIT);
127                 //STRINGIFY_OPCODE(BONE_CONSTRAINT);
128                 //STRINGIFY_OPCODE(BONE_CONSTRAINTS_DONE);
129                 STRINGIFY_OPCODE(BONE_READY);
130                 STRINGIFY_OPCODE(BONE_DONE);
131                 STRINGIFY_OPCODE(PSYS_EVAL);
132
133                 case DEG_NUM_OPCODES: return "SpecialCase";
134 #undef STRINGIFY_OPCODE
135         }
136         return "UNKNOWN";
137 }
138
139 DepsOperationStringifier::DepsOperationStringifier() {
140         for (int i = 0; i < DEG_NUM_OPCODES; ++i) {
141                 names_[i] = stringify_opcode((eDepsOperation_Code)i);
142         }
143 }
144
145 const char *DepsOperationStringifier::operator[](eDepsOperation_Code opcode) {
146         BLI_assert((opcode > 0) && (opcode < DEG_NUM_OPCODES));
147         if (opcode >= 0 && opcode < DEG_NUM_OPCODES) {
148                 return names_[opcode];
149         }
150         return "UnknownOpcode";
151 }
152
153 }  // namespace DEG
154
155 /* Register all node types */
156 void DEG_register_node_types(void)
157 {
158         /* initialise registry */
159         DEG::_depsnode_typeinfo_registry = BLI_ghash_int_new("Depsgraph Node Type Registry");
160
161         /* register node types */
162         DEG::deg_register_base_depsnodes();
163         DEG::deg_register_component_depsnodes();
164         DEG::deg_register_operation_depsnodes();
165 }
166
167 /* Free registry on exit */
168 void DEG_free_node_types(void)
169 {
170         BLI_ghash_free(DEG::_depsnode_typeinfo_registry, NULL, NULL);
171 }