Blender V5.3
deg_builder_relations.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2013 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <cstring>
12
14
15#include "DNA_ID.h"
16#include "DNA_listBase.h"
17
18#include "BLI_span.hh"
19
20#include "BKE_lib_query.hh" /* For LibraryForeachIDCallbackFlag enum. */
21
27#include "intern/depsgraph.hh"
32
33namespace blender {
34
35struct CacheFile;
36struct Camera;
37struct Collection;
38struct EffectorWeights;
39struct FCurve;
40struct FreestyleLineSet;
42struct ID;
43struct IDProperty;
44struct Image;
45struct Key;
46struct LayerCollection;
47struct Light;
48struct LightProbe;
49struct Main;
50struct Mask;
51struct Material;
52struct MovieClip;
53struct NlaStrip;
54struct Object;
55struct ParticleSettings;
56struct ParticleSystem;
57struct Scene;
58struct Speaker;
59struct Tex;
60struct VFont;
61struct ViewLayer;
62struct World;
63struct bAction;
64struct bArmature;
65struct bConstraint;
66struct bNodeSocket;
67struct bNodeTree;
68struct bPoseChannel;
69struct bSound;
70
71namespace deg {
72
73struct ComponentNode;
74struct DepsNodeHandle;
75struct Depsgraph;
77struct IDNode;
78struct Node;
79struct OperationNode;
80struct Relation;
81struct RootPChanMap;
82struct TimeSourceNode;
83
85 public:
87
88 void begin_build();
89
90 template<typename KeyFrom, typename KeyTo>
91 Relation *add_relation(const KeyFrom &key_from,
92 const KeyTo &key_to,
93 const char *description,
94 int flags = 0);
95
96 template<typename KeyTo>
97 Relation *add_relation(const TimeSourceKey &key_from,
98 const KeyTo &key_to,
99 const char *description,
100 int flags = 0);
101
102 template<typename KeyType>
103 requires(!std::is_same_v<KeyType, TimeSourceKey>)
104 Relation *add_node_handle_relation(const KeyType &key_from,
105 const DepsNodeHandle *handle,
106 const char *description,
107 int flags = 0);
108
110 const DepsNodeHandle *handle,
111 const char *description,
112 int flags = 0);
113
114 template<typename KeyTo>
116 const KeyTo &key_to,
117 const char *description,
118 int flags = 0);
119
120 /* Adds relation from proper transformation operation to the modifier.
121 * Takes care of checking for possible physics solvers modifying position
122 * of this object. */
123 void add_depends_on_transform_relation(const DepsNodeHandle *handle, const char *description);
124
125 void add_customdata_mask(Object *object, const DEGCustomDataMeshMasks &customdata_masks);
126 void add_special_eval_flag(ID *id, uint32_t flag);
127
128 virtual void build_id(ID *id);
129
130 /* Build function for ID types that do not need their own build_xxx() function. */
131 virtual void build_generic_id(ID *id);
132
133 virtual void build_idproperties(IDProperty *id_property);
134
135 virtual void build_scene_camera(Scene *scene);
136 virtual void build_scene_render(Scene *scene, ViewLayer *view_layer);
137 virtual void build_scene_parameters(Scene *scene);
138 virtual void build_scene_compositor(Scene *scene);
139
140 /* Excluded layer collections are not built themselves, but their children are, attached to
141 * `parent_hierarchy_key`: the nearest non-excluded ancestor (or the scene). */
142 virtual void build_layer_collections(LayerCollection *layer_collection,
143 const ComponentKey &parent_hierarchy_key);
144 virtual void build_view_layer_collections(ViewLayer *view_layer);
145
146 virtual void build_view_layer(Scene *scene,
147 ViewLayer *view_layer,
148 eDepsNode_LinkedState_Type linked_state);
149 virtual void build_collection(LayerCollection *from_layer_collection, Collection *collection);
150 virtual void build_object(Object *object);
151 virtual void build_object_from_view_layer_base(Object *object);
153 virtual void build_object_modifiers(Object *object);
154 virtual void build_object_data(Object *object);
155 virtual void build_object_data_camera(Object *object);
156 virtual void build_object_data_geometry(Object *object);
157 virtual void build_object_data_geometry_datablock(ID *obdata);
158 virtual void build_object_data_empty(Object *object);
159 virtual void build_object_data_light(Object *object);
160 virtual void build_object_data_lightprobe(Object *object);
161 virtual void build_object_data_speaker(Object *object);
162 virtual void build_object_parent(Object *object);
163 virtual void build_object_pointcache(Object *object);
164 virtual void build_object_instance_collection(Object *object);
165
166 virtual void build_object_shading(Object *object);
167
168 virtual void build_object_light_linking(Object *emitter);
169 virtual void build_light_linking_collection(Object *emitter, Collection *collection);
170
171 virtual void build_constraints(ID *id,
172 NodeType component_type,
173 const char *component_subdata,
174 ListBaseT<bConstraint> *constraints,
175 RootPChanMap *root_map);
176 virtual void build_animdata(ID *id);
177 virtual void build_animdata_curves(ID *id);
178 virtual void build_animdata_fcurve_target(ID *id,
179 PointerRNA id_ptr,
180 ComponentKey &adt_key,
181 OperationNode *operation_from,
182 FCurve *fcu);
183 virtual void build_animdata_action_targets(ID *id,
184 int32_t slot_handle,
185 ComponentKey &adt_key,
186 OperationNode *operation_from,
187 bAction *action);
188 virtual void build_animdata_nlastrip_targets(ID *id,
189 ComponentKey &adt_key,
190 OperationNode *operation_from,
191 ListBaseT<NlaStrip> *strips);
192 virtual void build_animdata_drivers(ID *id);
193 virtual void build_animdata_force(ID *id);
194 virtual void build_animation_images(ID *id);
195 virtual void build_action(bAction *action);
196 virtual void build_driver(ID *id, FCurve *fcurve);
197 virtual void build_driver_data(ID *id, FCurve *fcurve);
198 virtual void build_driver_variables(ID *id, FCurve *fcurve);
199
200 virtual void build_driver_scene_camera_variable(const OperationKey &driver_key,
201 const RNAPathKey &self_key,
202 Scene *scene,
203 const char *rna_path);
204 virtual void build_driver_rna_path_variable(const OperationKey &driver_key,
205 const RNAPathKey &self_key,
206 ID *target_id,
207 const PointerRNA &target_prop,
208 const char *rna_path);
209
210 /* Build operations of a property value from which is read by a driver target.
211 *
212 * The driver target points to a data-block (or a sub-data-block like View Layer).
213 * This data-block is presented in the interface as a "Prop" and its resolved RNA pointer is
214 * passed here as `target_prop`.
215 *
216 * The tricky part (and a bit confusing naming) is that the driver target accesses a property of
217 * the `target_prop` to get its value. The property which is read to give an actual target value
218 * is denoted by its RNA path relative to the `target_prop`. In the interface it is called "Path"
219 * and here it is called `rna_path_from_target_prop`. */
220 virtual void build_driver_id_property(const PointerRNA &target_prop,
221 const char *rna_path_from_target_prop);
222
223 virtual void build_parameters(ID *id);
224 virtual void build_dimensions(Object *object);
225 virtual void build_world(World *world);
226 virtual void build_rigidbody(Scene *scene);
227 virtual void build_particle_systems(Object *object);
228 virtual void build_particle_settings(ParticleSettings *part);
230 ParticleSystem *psys,
231 Object *draw_object);
232 virtual void build_ik_pose(Object *object,
233 bPoseChannel *pchan,
234 bConstraint *con,
235 RootPChanMap *root_map);
236 virtual void build_splineik_pose(Object *object,
237 bPoseChannel *pchan,
238 bConstraint *con,
239 RootPChanMap *root_map);
240 virtual void build_inter_ik_chains(Object *object,
241 const OperationKey &solver_key,
242 const bPoseChannel *rootchan,
243 const RootPChanMap *root_map);
244 virtual void build_rig(Object *object);
245 virtual void build_shapekeys(Key *key);
246 virtual void build_armature(bArmature *armature);
247 virtual void build_armature_bones(ListBaseT<Bone> *bones);
249 virtual void build_camera(Camera *camera);
250 virtual void build_light(Light *lamp);
251 virtual void build_nodetree(bNodeTree *ntree);
252 virtual void build_nodetree_socket(bNodeSocket *socket);
253 virtual void build_material(Material *ma, ID *owner = nullptr);
254 virtual void build_materials(ID *owner, Material **materials, int num_materials);
255 virtual void build_freestyle_lineset(FreestyleLineSet *fls);
256 virtual void build_freestyle_linestyle(FreestyleLineStyle *linestyle);
257 virtual void build_texture(Tex *tex);
258 virtual void build_image(Image *image);
259 virtual void build_cachefile(CacheFile *cache_file);
260 virtual void build_mask(Mask *mask);
261 virtual void build_movieclip(MovieClip *clip);
262 virtual void build_lightprobe(LightProbe *probe);
263 virtual void build_speaker(Speaker *speaker);
264 virtual void build_sound(bSound *sound);
265 virtual void build_scene_sequencer(Scene *scene);
266 virtual void build_scene_audio(Scene *scene);
267 virtual void build_scene_speakers(Scene *scene, ViewLayer *view_layer);
268 virtual void build_vfont(VFont *vfont);
269
270 virtual void build_nested_datablock(ID *owner, ID *id, bool flush_cow_changes);
271 virtual void build_nested_nodetree(ID *owner, bNodeTree *ntree);
272 virtual void build_nested_shapekey(ID *owner, Key *key);
273
275 Object *object,
276 Collection *collection,
277 const char *name);
279 Object *object,
280 ParticleSystem *psys,
281 EffectorWeights *eff,
282 bool add_absorption,
283 const char *name);
284
285 virtual void build_copy_on_write_relations();
286 virtual void build_copy_on_write_relations(IDNode *id_node);
287 virtual void build_driver_relations();
288 virtual void build_driver_relations(IDNode *id_node);
289
290 template<typename KeyType> OperationNode *find_operation_node(const KeyType &key);
291
293
294 virtual Set<const ID *> get_built_ids() const;
295
296 protected:
297 TimeSourceNode *get_node(const TimeSourceKey &key) const;
298 ComponentNode *get_node(const ComponentKey &key) const;
299 OperationNode *get_node(const OperationKey &key) const;
300 Node *get_node(const RNAPathKey &key);
301
302 OperationNode *find_node(const OperationKey &key) const;
303 ComponentNode *find_node(const ComponentKey &key) const;
304 bool has_node(const ComponentKey &key) const;
305 bool has_node(const OperationKey &key) const;
306
308 Node *node_to,
309 const char *description,
310 int flags = 0);
311
312 /* Add relation which ensures visibility of `id_from` when `id_to` is visible.
313 * For the more detailed explanation see comment for `NodeType::VISIBILITY`. */
314 void add_visibility_relation(ID *id_from, ID *id_to);
315
317 OperationNode *node_to,
318 const char *description,
319 int flags = 0);
320
321 template<typename KeyType>
322 DepsNodeHandle create_node_handle(const KeyType &key, const char *default_name = "");
323
324 /* TODO(sergey): All those is_same* functions are to be generalized. */
325
326 /* Check whether two keys corresponds to the same bone from same armature.
327 *
328 * This is used by drivers relations builder to avoid possible fake
329 * dependency cycle when one bone property drives another property of the
330 * same bone. */
331 template<typename KeyFrom, typename KeyTo>
332 bool is_same_bone_dependency(const KeyFrom &key_from, const KeyTo &key_to);
333
334 /* Similar to above, but used to check whether driver is using node from
335 * the same node tree as a driver variable. */
336 template<typename KeyFrom, typename KeyTo>
337 bool is_same_nodetree_node_dependency(const KeyFrom &key_from, const KeyTo &key_to);
338
339 private:
340 struct BuilderWalkUserData {
342 };
343
344 static void modifier_walk(void *user_data,
345 struct Object *object,
346 struct ID **idpoin,
348
349 static void constraint_walk(bConstraint *con, ID **idpoin, bool is_reference, void *user_data);
350
351 /* State which demotes currently built entities. */
352 Scene *scene_;
353
354 BuilderMap built_map_;
355 RNANodeQuery rna_node_query_;
356 BuilderStack stack_;
357};
358
372
373} // namespace deg
374} // namespace blender
375
376#include "intern/builder/deg_builder_relations_impl.h" // IWYU pragma: export
ID and Library types, which are fundamental for SDNA.
These structs are the foundation for all linked lists in the library system.
btSequentialImpulseConstraintSolverMt int btPersistentManifold int btTypedConstraint ** constraints
DepsgraphBuilder(Main *bmain, Depsgraph *graph, DepsgraphBuilderCache *cache)
virtual void build_driver_rna_path_variable(const OperationKey &driver_key, const RNAPathKey &self_key, ID *target_id, const PointerRNA &target_prop, const char *rna_path)
void add_particle_collision_relations(const OperationKey &key, Object *object, Collection *collection, const char *name)
Relation * add_node_handle_relation(const KeyType &key_from, const DepsNodeHandle *handle, const char *description, int flags=0)
virtual void build_animdata_action_targets(ID *id, int32_t slot_handle, ComponentKey &adt_key, OperationNode *operation_from, bAction *action)
Relation * add_depends_on_transform_relation(ID *id, const KeyTo &key_to, const char *description, int flags=0)
virtual void build_freestyle_linestyle(FreestyleLineStyle *linestyle)
virtual void build_ik_pose(Object *object, bPoseChannel *pchan, bConstraint *con, RootPChanMap *root_map)
virtual void build_collection(LayerCollection *from_layer_collection, Collection *collection)
virtual void build_constraints(ID *id, NodeType component_type, const char *component_subdata, ListBaseT< bConstraint > *constraints, RootPChanMap *root_map)
virtual void build_driver_id_property(const PointerRNA &target_prop, const char *rna_path_from_target_prop)
virtual void build_object_layer_component_relations(Object *object)
virtual void build_object_from_view_layer_base(Object *object)
virtual void build_driver(ID *id, FCurve *fcurve)
virtual void build_armature_bone_collections(Span< BoneCollection * > collections)
virtual void build_driver_data(ID *id, FCurve *fcurve)
virtual void build_nested_nodetree(ID *owner, bNodeTree *ntree)
virtual void build_nodetree_socket(bNodeSocket *socket)
virtual void build_material(Material *ma, ID *owner=nullptr)
virtual void build_speaker(Speaker *speaker)
TimeSourceNode * get_node(const TimeSourceKey &key) const
bool is_same_nodetree_node_dependency(const KeyFrom &key_from, const KeyTo &key_to)
virtual void build_scene_speakers(Scene *scene, ViewLayer *view_layer)
OperationNode * find_node(const OperationKey &key) const
virtual void build_armature(bArmature *armature)
virtual void build_view_layer(Scene *scene, ViewLayer *view_layer, eDepsNode_LinkedState_Type linked_state)
virtual void build_object_pointcache(Object *object)
virtual void build_object_modifiers(Object *object)
virtual void build_view_layer_collections(ViewLayer *view_layer)
virtual void build_object_data_light(Object *object)
void add_customdata_mask(Object *object, const DEGCustomDataMeshMasks &customdata_masks)
virtual Set< const ID * > get_built_ids() const
bool is_same_bone_dependency(const KeyFrom &key_from, const KeyTo &key_to)
virtual void build_object_data_empty(Object *object)
virtual void build_object_data_camera(Object *object)
virtual void build_scene_render(Scene *scene, ViewLayer *view_layer)
virtual void build_object_data_geometry(Object *object)
DepsgraphRelationBuilder(Main *bmain, Depsgraph *graph, DepsgraphBuilderCache *cache)
virtual void build_object_data_lightprobe(Object *object)
virtual void build_particle_settings(ParticleSettings *part)
virtual void build_object_light_linking(Object *emitter)
void add_special_eval_flag(ID *id, uint32_t flag)
virtual void build_driver_scene_camera_variable(const OperationKey &driver_key, const RNAPathKey &self_key, Scene *scene, const char *rna_path)
virtual void build_movieclip(MovieClip *clip)
virtual void build_nodetree(bNodeTree *ntree)
Relation * add_relation(const KeyFrom &key_from, const KeyTo &key_to, const char *description, int flags=0)
virtual void build_object_data_geometry_datablock(ID *obdata)
virtual void build_layer_collections(LayerCollection *layer_collection, const ComponentKey &parent_hierarchy_key)
virtual void build_animdata_fcurve_target(ID *id, PointerRNA id_ptr, ComponentKey &adt_key, OperationNode *operation_from, FCurve *fcu)
void add_particle_forcefield_relations(const OperationKey &key, Object *object, ParticleSystem *psys, EffectorWeights *eff, bool add_absorption, const char *name)
virtual void build_nested_datablock(ID *owner, ID *id, bool flush_cow_changes)
virtual void build_particle_system_visualization_object(Object *object, ParticleSystem *psys, Object *draw_object)
virtual void build_lightprobe(LightProbe *probe)
void add_visibility_relation(ID *id_from, ID *id_to)
virtual void build_splineik_pose(Object *object, bPoseChannel *pchan, bConstraint *con, RootPChanMap *root_map)
virtual void build_driver_variables(ID *id, FCurve *fcurve)
virtual void build_armature_bones(ListBaseT< Bone > *bones)
virtual void build_object_instance_collection(Object *object)
virtual void build_nested_shapekey(ID *owner, Key *key)
virtual void build_object_parent(Object *object)
bool has_node(const ComponentKey &key) const
virtual void build_inter_ik_chains(Object *object, const OperationKey &solver_key, const bPoseChannel *rootchan, const RootPChanMap *root_map)
virtual void build_object_data_speaker(Object *object)
virtual void build_freestyle_lineset(FreestyleLineSet *fls)
virtual void build_light_linking_collection(Object *emitter, Collection *collection)
Relation * add_operation_relation(OperationNode *node_from, OperationNode *node_to, const char *description, int flags=0)
OperationNode * find_operation_node(const KeyType &key)
virtual void build_animdata_nlastrip_targets(ID *id, ComponentKey &adt_key, OperationNode *operation_from, ListBaseT< NlaStrip > *strips)
virtual void build_object_data(Object *object)
virtual void build_idproperties(IDProperty *id_property)
virtual void build_materials(ID *owner, Material **materials, int num_materials)
virtual void build_cachefile(CacheFile *cache_file)
virtual void build_object_shading(Object *object)
DepsNodeHandle create_node_handle(const KeyType &key, const char *default_name="")
Relation * add_time_relation(TimeSourceNode *timesrc, Node *node_to, const char *description, int flags=0)
virtual void build_particle_systems(Object *object)
void camera(KernelGlobals &kg, const ShadingData &sd, float3 &outview, float &outdepth, float &outdist)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
unsigned int uint32_t
Definition BKE_text.h:81
signed int int32_t
Definition BKE_text.h:78
LibraryForeachIDCallbackFlag
DepsgraphRelationBuilder * builder
DepsNodeHandle(DepsgraphRelationBuilder *builder, OperationNode *node, const char *default_name="")