Fix T52134: New depsgraph crashes when evaluating several psys on from object
[blender.git] / source / blender / depsgraph / intern / depsgraph_types.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) 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_types.h
28  *  \ingroup depsgraph
29  *
30  * Datatypes for internal use in the Depsgraph
31  *
32  * All of these datatypes are only really used within the "core" depsgraph.
33  * In particular, node types declared here form the structure of operations
34  * in the graph.
35  */
36
37 #pragma once
38
39 #include "util/deg_util_function.h"
40
41 /* TODO(sergey): Ideally we'll just use char* and statically allocated strings
42  * to avoid any possible overhead caused by string (re)allocation/formatting.
43  */
44 #include <string>
45 #include <vector>
46
47 struct bAction;
48 struct ChannelDriver;
49 struct ModifierData;
50 struct PointerRNA;
51 struct EvaluationContext;
52 struct FCurve;
53
54 namespace DEG {
55
56 using std::string;
57 using std::vector;
58
59 /* Evaluation Operation for atomic operation */
60 // XXX: move this to another header that can be exposed?
61 typedef function<void(struct EvaluationContext *)> DepsEvalOperationCb;
62
63 /* Metatype of Nodes - The general "level" in the graph structure
64  * the node serves.
65  */
66 typedef enum eDepsNode_Class {
67         /* Types generally unassociated with user-visible entities,
68          * but needed for graph functioning.
69          */
70         DEG_NODE_CLASS_GENERIC         = 0,
71         /* [Outer Node] An "aspect" of evaluating/updating an ID-Block, requiring
72          * certain types of evaluation behavior.
73          */
74         DEG_NODE_CLASS_COMPONENT       = 1,
75         /* [Inner Node] A glorified function-pointer/callback for scheduling up
76          * evaluation operations for components, subject to relationship
77          * requirements.
78          */
79         DEG_NODE_CLASS_OPERATION       = 2,
80 } eDepsNode_Class;
81
82 /* Types of Nodes */
83 typedef enum eDepsNode_Type {
84         /* Fallback type for invalid return value */
85         DEG_NODE_TYPE_UNDEFINED        = -1,
86         /* Inner Node (Operation) */
87         DEG_NODE_TYPE_OPERATION        = 0,
88
89         /* **** Generic Types **** */
90
91         /* Time-Source */
92         DEG_NODE_TYPE_TIMESOURCE,
93         /* ID-Block reference - used as landmarks/collection point for components,
94          * but not usually part of main graph.
95          */
96         DEG_NODE_TYPE_ID_REF,
97
98         /* **** Outer Types **** */
99
100         /* Parameters Component - Default when nothing else fits
101          * (i.e. just SDNA property setting).
102          */
103         DEG_NODE_TYPE_PARAMETERS,
104         /* Generic "Proxy-Inherit" Component. */
105         DEG_NODE_TYPE_PROXY,
106         /* Animation Component
107          *
108          * XXX: merge in with parameters?
109          */
110         DEG_NODE_TYPE_ANIMATION,
111         /* Transform Component (Parenting/Constraints) */
112         DEG_NODE_TYPE_TRANSFORM,
113         /* Geometry Component (DerivedMesh/Displist) */
114         DEG_NODE_TYPE_GEOMETRY,
115         /* Sequencer Component (Scene Only) */
116         DEG_NODE_TYPE_SEQUENCER,
117
118         /* **** Evaluation-Related Outer Types (with Subdata) **** */
119
120         /* Pose Component - Owner/Container of Bones Eval */
121         DEG_NODE_TYPE_EVAL_POSE,
122         /* Bone Component - Child/Subcomponent of Pose */
123         DEG_NODE_TYPE_BONE,
124         /* Particle Systems Component */
125         DEG_NODE_TYPE_EVAL_PARTICLES,
126         /* Material Shading Component */
127         DEG_NODE_TYPE_SHADING,
128         /* Cache Component */
129         DEG_NODE_TYPE_CACHE,
130 } eDepsNode_Type;
131
132 /* Identifiers for common operations (as an enum). */
133 typedef enum eDepsOperation_Code {
134         /* Generic Operations ------------------------------ */
135
136         /* Placeholder for operations which don't need special mention */
137         DEG_OPCODE_OPERATION = 0,
138
139         // XXX: Placeholder while porting depsgraph code
140         DEG_OPCODE_PLACEHOLDER,
141
142         /* Animation, Drivers, etc. ------------------------ */
143
144         /* NLA + Action */
145         DEG_OPCODE_ANIMATION,
146
147         /* Driver */
148         DEG_OPCODE_DRIVER,
149
150         /* Transform --------------------------------------- */
151
152         /* Transform entry point - local transforms only */
153         DEG_OPCODE_TRANSFORM_LOCAL,
154
155         /* Parenting */
156         DEG_OPCODE_TRANSFORM_PARENT,
157
158         /* Constraints */
159         DEG_OPCODE_TRANSFORM_CONSTRAINTS,
160
161         /* Rigidbody Sim - Perform Sim */
162         DEG_OPCODE_RIGIDBODY_REBUILD,
163         DEG_OPCODE_RIGIDBODY_SIM,
164
165         /* Rigidbody Sim - Copy Results to Object */
166         DEG_OPCODE_TRANSFORM_RIGIDBODY,
167
168         /* Transform exitpoint */
169         DEG_OPCODE_TRANSFORM_FINAL,
170
171         /* XXX: ubereval is for temporary porting purposes only */
172         DEG_OPCODE_OBJECT_UBEREVAL,
173
174         /* Geometry ---------------------------------------- */
175
176         /* XXX: Placeholder - UberEval */
177         DEG_OPCODE_GEOMETRY_UBEREVAL,
178
179         /* Curve Objects - Path Calculation (used for path-following tools, */
180         DEG_OPCODE_GEOMETRY_PATH,
181
182         /* Pose -------------------------------------------- */
183
184         /* Init IK Trees, etc. */
185         DEG_OPCODE_POSE_INIT,
186
187         /* Free IK Trees + Compute Deform Matrices */
188         DEG_OPCODE_POSE_DONE,
189
190         /* IK/Spline Solvers */
191         DEG_OPCODE_POSE_IK_SOLVER,
192         DEG_OPCODE_POSE_SPLINE_IK_SOLVER,
193
194         /* Bone -------------------------------------------- */
195
196         /* Bone local transforms - Entrypoint */
197         DEG_OPCODE_BONE_LOCAL,
198
199         /* Pose-space conversion (includes parent + restpose, */
200         DEG_OPCODE_BONE_POSE_PARENT,
201
202         /* Constraints */
203         DEG_OPCODE_BONE_CONSTRAINTS,
204
205         /* Bone transforms are ready
206          *
207          * - "READY"  This (internal, noop is used to signal that all pre-IK
208          *            operations are done. Its role is to help mediate situations
209          *            where cyclic relations may otherwise form (i.e. one bone in
210          *            chain targetting another in same chain,
211          *
212          * - "DONE"   This noop is used to signal that the bone's final pose
213          *            transform can be read by others
214          */
215         // TODO: deform mats could get calculated in the final_transform ops...
216         DEG_OPCODE_BONE_READY,
217         DEG_OPCODE_BONE_DONE,
218
219         /* Particles --------------------------------------- */
220
221         /* XXX: placeholder - Particle System eval */
222         DEG_OPCODE_PSYS_EVAL_INIT,
223         DEG_OPCODE_PSYS_EVAL,
224
225         DEG_NUM_OPCODES,
226 } eDepsOperation_Code;
227
228 /* Some magic to stringify operation codes. */
229 class DepsOperationStringifier {
230 public:
231         DepsOperationStringifier();
232         const char *operator[](eDepsOperation_Code opcodex);
233 protected:
234         const char *names_[DEG_NUM_OPCODES];
235 };
236
237 /* String defines for these opcodes, defined in depsgraph_type_defines.cpp */
238 extern DepsOperationStringifier DEG_OPNAMES;
239
240 }  // namespace DEG