Blender V5.3
deg_builder_nodes.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 "BKE_lib_query.hh" /* For LibraryForeachIDCallbackFlag enum. */
12
13#include "BLI_set.hh"
14
15#include "DNA_armature_types.h"
16#include "DNA_listBase.h"
17
24
25#include "DEG_depsgraph.hh"
26
27namespace blender {
28
29struct BoneCollection;
30struct CacheFile;
31struct Camera;
32struct Collection;
33struct FCurve;
34struct FreestyleLineSet;
36struct ID;
37struct IDProperty;
38struct Image;
39struct Key;
40struct LayerCollection;
41struct Light;
42struct LightProbe;
43struct Main;
44struct Mask;
45struct Material;
46struct MovieClip;
47struct NlaStrip;
48struct Object;
49struct ParticleSettings;
50struct Scene;
51struct Speaker;
52struct Tex;
53struct VFont;
54struct World;
55struct bAction;
56struct bArmature;
57struct bConstraint;
58struct bNodeSocket;
59struct bNodeTree;
60struct bPoseChannel;
61struct bSound;
62struct PointerRNA;
63
64namespace deg {
65
66struct ComponentNode;
67struct Depsgraph;
69struct IDNode;
70struct OperationKey;
71struct OperationNode;
72struct TimeSourceNode;
73
75 public:
77 ~DepsgraphNodeBuilder() override;
78
79 /* For given original ID get ID which is created by copy-on-evaluation system. */
80 ID *get_cow_id(const ID *id_orig) const;
81 /* Similar to above, but for the cases when there is no ID node we create
82 * one. */
83 ID *ensure_cow_id(ID *id_orig);
84
85 /* Helper wrapper function which wraps get_cow_id with a needed type cast. */
86 template<typename T> T *get_cow_datablock(const T *orig) const
87 {
88 return (T *)get_cow_id(&orig->id);
89 }
90
91 /* For a given evaluated datablock get corresponding original one. */
92 template<typename T> T *get_orig_datablock(const T *cow) const
93 {
94 return (T *)cow->id.orig_id;
95 }
96
97 virtual void begin_build();
98 virtual void end_build();
99
104 int foreach_id_cow_detect_need_for_update_callback(ID *id_cow_self, ID *id_pointer);
105
106 IDNode *add_id_node(ID *id);
107 IDNode *find_id_node(const ID *id);
109
110 ComponentNode *add_component_node(ID *id, NodeType comp_type, const char *comp_name = "");
111 ComponentNode *find_component_node(const ID *id, NodeType comp_type, const char *comp_name = "");
112
114 OperationCode opcode,
115 const DepsEvalOperationCb &op = nullptr,
116 const char *name = "",
117 int name_tag = -1);
119 NodeType comp_type,
120 const char *comp_name,
121 OperationCode opcode,
122 const DepsEvalOperationCb &op = nullptr,
123 const char *name = "",
124 int name_tag = -1);
126 NodeType comp_type,
127 OperationCode opcode,
128 const DepsEvalOperationCb &op = nullptr,
129 const char *name = "",
130 int name_tag = -1);
131
133 NodeType comp_type,
134 const char *comp_name,
135 OperationCode opcode,
136 const DepsEvalOperationCb &op = nullptr,
137 const char *name = "",
138 int name_tag = -1);
140 NodeType comp_type,
141 OperationCode opcode,
142 const DepsEvalOperationCb &op = nullptr,
143 const char *name = "",
144 int name_tag = -1);
145
146 bool has_operation_node(ID *id,
147 NodeType comp_type,
148 const char *comp_name,
149 OperationCode opcode,
150 const char *name = "",
151 int name_tag = -1);
152 bool has_operation_node(ID *id, NodeType comp_type, OperationCode opcode);
153
155 NodeType comp_type,
156 const char *comp_name,
157 OperationCode opcode,
158 const char *name = "",
159 int name_tag = -1);
160
162 NodeType comp_type,
163 OperationCode opcode,
164 const char *name = "",
165 int name_tag = -1);
166
168
169 virtual void build_id(ID *id, bool force_be_visible = false);
170
171 /* Build function for ID types that do not need their own build_xxx() function. */
172 virtual void build_generic_id(ID *id);
173
174 virtual void build_idproperties(IDProperty *id_property);
175
176 virtual void build_scene_render(Scene *scene, ViewLayer *view_layer);
177 virtual void build_scene_camera(Scene *scene);
178 virtual void build_scene_parameters(Scene *scene);
179 virtual void build_scene_compositor(Scene *scene);
180
181 virtual void build_empty_object(Object *object);
182
183 virtual void build_layer_collections(ListBaseT<LayerCollection> *lb);
184 virtual void build_view_layer(Scene *scene,
185 ViewLayer *view_layer,
186 eDepsNode_LinkedState_Type linked_state);
187 virtual void build_collection(LayerCollection *from_layer_collection, Collection *collection);
188 virtual void build_object(int base_index,
189 Object *object,
190 eDepsNode_LinkedState_Type linked_state,
191 bool is_visible);
192 virtual void build_object_instance_collection(Object *object, bool is_object_visible);
193 virtual void build_object_from_layer(int base_index,
194 Object *object,
195 eDepsNode_LinkedState_Type linked_state);
196 virtual void build_object_flags(int base_index,
197 Object *object,
198 eDepsNode_LinkedState_Type linked_state);
199 virtual void build_object_modifiers(Object *object);
200 virtual void build_object_data(Object *object);
201 virtual void build_object_data_camera(Object *object);
202 virtual void build_object_data_geometry(Object *object);
203 virtual void build_object_data_geometry_datablock(ID *obdata);
204 virtual void build_object_data_light(Object *object);
205 virtual void build_object_data_lightprobe(Object *object);
206 virtual void build_object_data_speaker(Object *object);
207 virtual void build_object_data_grease_pencil(Object *object);
208 virtual void build_object_transform(Object *object);
209 virtual void build_object_constraints(Object *object);
210 virtual void build_object_pointcache(Object *object);
211 virtual void build_object_shading(Object *object);
212
213 virtual void build_object_light_linking(Object *object);
214 virtual void build_light_linking_collection(Collection *collection);
215
216 virtual void build_pose_constraints(Object *object, bPoseChannel *pchan, int pchan_index);
217 virtual void build_rigidbody(Scene *scene);
218 virtual void build_particle_systems(Object *object, bool is_object_visible);
219 virtual void build_particle_settings(ParticleSettings *part);
224 virtual void build_animdata(ID *id);
225 virtual void build_animdata_nlastrip_targets(ListBaseT<NlaStrip> *strips);
229 virtual void build_animation_images(ID *id);
230 virtual void build_action(bAction *action);
231
232 virtual void build_animdata_drivers(ID *id, AnimData *adt);
239 virtual void build_driver(ID *id, FCurve *fcurve, int driver_index);
240
241 virtual void build_driver_variables(ID *id, FCurve *fcurve);
242 virtual void build_driver_scene_camera_variable(Scene *scene, const char *camera_path);
243
244 /* Build operations of a property value from which is read by a driver target.
245 *
246 * The driver target points to a data-block (or a sub-data-block like View Layer).
247 * This data-block is presented in the interface as a "Prop" and its resolved RNA pointer is
248 * passed here as `target_prop`.
249 *
250 * The tricky part (and a bit confusing naming) is that the driver target accesses a property of
251 * the `target_prop` to get its value. The property which is read to give an actual target value
252 * is denoted by its RNA path relative to the `target_prop`. In the interface it is called "Path"
253 * and here it is called `rna_path_from_target_prop`. */
254 virtual void build_driver_id_property(const PointerRNA &target_prop,
255 const char *rna_path_from_target_prop);
256
257 virtual void build_parameters(ID *id);
258 virtual void build_dimensions(Object *object);
260 virtual void build_ik_pose(Object *object, bPoseChannel *pchan, bConstraint *con);
262 virtual void build_splineik_pose(Object *object, bPoseChannel *pchan, bConstraint *con);
264 virtual void build_rig(Object *object);
265 virtual void build_armature(bArmature *armature);
266 virtual void build_armature_bones(ListBaseT<Bone> *bones);
269 virtual void build_shapekeys(Key *key);
270 virtual void build_camera(Camera *camera);
271 virtual void build_light(Light *lamp);
272 virtual void build_nodetree(bNodeTree *ntree);
273 virtual void build_nodetree_socket(bNodeSocket *socket);
275 virtual void build_material(Material *ma);
276 virtual void build_materials(Material **materials, int num_materials);
277 virtual void build_freestyle_lineset(FreestyleLineSet *fls);
278 virtual void build_freestyle_linestyle(FreestyleLineStyle *linestyle);
280 virtual void build_texture(Tex *tex);
281 virtual void build_image(Image *image);
283 virtual void build_world(World *world);
284 virtual void build_cachefile(CacheFile *cache_file);
285 virtual void build_mask(Mask *mask);
286 virtual void build_movieclip(MovieClip *clip);
287 virtual void build_lightprobe(LightProbe *probe);
288 virtual void build_speaker(Speaker *speaker);
289 virtual void build_sound(bSound *sound);
290 virtual void build_scene_sequencer(Scene *scene);
291 virtual void build_scene_audio(Scene *scene);
292 virtual void build_scene_speakers(Scene *scene, ViewLayer *view_layer);
293 virtual void build_vfont(VFont *vfont);
294
295 virtual Set<const ID *> get_built_ids() const;
296
297 /* Per-ID information about what was already in the dependency graph.
298 * Allows to re-use certain values, to speed up following evaluation. */
299 struct IDInfo {
300 /* Copy-on-written pointer of the corresponding ID. */
301 ID *id_cow = nullptr;
302 /* Mask of visible components from previous state of the
303 * dependency graph. */
305 /* Special evaluation flag mask from the previous depsgraph. */
307 /* Mesh CustomData mask from the previous depsgraph. */
309 };
310
311 protected:
312 /* Entry tags and non-updated operations from the previous state of the dependency graph.
313 * The entry tags are operations which were directly tagged, the matching operations from the
314 * new dependency graph will be tagged. The needs-update operations are possibly indirectly
315 * modified operations, whose complementary part from the new dependency graph will only be
316 * marked as needs-update.
317 * Stored before the graph is re-created so that they can be transferred over. */
320
324 static void modifier_walk(void *user_data,
325 struct Object *object,
326 struct ID **idpoin,
328 static void constraint_walk(bConstraint *constraint,
329 ID **idpoin,
330 bool is_reference,
331 void *user_data);
332
339
340 /* State which demotes currently built entities. */
344 /* NOTE: Collection are possibly built recursively, so be careful when
345 * setting the current state. */
346 /* Accumulated flag over the hierarchy of currently building collections.
347 * Denotes whether all the hierarchy from parent of `collection_` to the
348 * very root is visible (aka not restricted.). */
350
351 /* Indexed by original ID.session_uid, values are IDInfo. */
353
354 /* Set of IDs which were already build. Makes it easier to keep track of
355 * what was already built and what was not. */
357};
358
359} // namespace deg
360} // namespace blender
These structs are the foundation for all linked lists in the library system.
DepsgraphBuilder(Main *bmain, Depsgraph *graph, DepsgraphBuilderCache *cache)
ComponentNode * find_component_node(const ID *id, NodeType comp_type, const char *comp_name="")
virtual void build_scene_parameters(Scene *scene)
virtual void build_scene_sequencer(Scene *scene)
virtual void build_object_data_camera(Object *object)
virtual void build_object_data_geometry(Object *object)
virtual void build_pose_constraints(Object *object, bPoseChannel *pchan, int pchan_index)
virtual void build_object_pointcache(Object *object)
virtual void build_world(World *world)
virtual void build_object(int base_index, Object *object, eDepsNode_LinkedState_Type linked_state, bool is_visible)
OperationNode * ensure_operation_node(ID *id, NodeType comp_type, const char *comp_name, OperationCode opcode, const DepsEvalOperationCb &op=nullptr, const char *name="", int name_tag=-1)
virtual void build_id(ID *id, bool force_be_visible=false)
virtual void build_freestyle_linestyle(FreestyleLineStyle *linestyle)
virtual void build_scene_speakers(Scene *scene, ViewLayer *view_layer)
virtual void build_cachefile(CacheFile *cache_file)
virtual void build_object_instance_collection(Object *object, bool is_object_visible)
virtual void build_object_data_speaker(Object *object)
OperationNode * add_operation_node(ComponentNode *comp_node, OperationCode opcode, const DepsEvalOperationCb &op=nullptr, const char *name="", int name_tag=-1)
virtual void build_vfont(VFont *vfont)
OperationNode * find_operation_node(const ID *id, NodeType comp_type, const char *comp_name, OperationCode opcode, const char *name="", int name_tag=-1)
virtual void build_object_data(Object *object)
virtual void build_particle_settings(ParticleSettings *part)
static void constraint_walk(bConstraint *constraint, ID **idpoin, bool is_reference, void *user_data)
virtual void build_scene_camera(Scene *scene)
virtual void build_driver_id_property(const PointerRNA &target_prop, const char *rna_path_from_target_prop)
virtual void build_particle_systems(Object *object, bool is_object_visible)
virtual void build_dimensions(Object *object)
virtual void build_armature(bArmature *armature)
virtual void build_scene_audio(Scene *scene)
ComponentNode * add_component_node(ID *id, NodeType comp_type, const char *comp_name="")
virtual void build_armature_bone_collections(Span< BoneCollection * > collections)
virtual void build_driver_variables(ID *id, FCurve *fcurve)
T * get_orig_datablock(const T *cow) const
virtual void build_action(bAction *action)
virtual void build_armature_bones(ListBaseT< Bone > *bones)
virtual void build_driver_scene_camera_variable(Scene *scene, const char *camera_path)
virtual Set< const ID * > get_built_ids() const
virtual void build_material(Material *ma)
virtual void build_animdata_nlastrip_targets(ListBaseT< NlaStrip > *strips)
virtual void build_materials(Material **materials, int num_materials)
virtual void build_collection(LayerCollection *from_layer_collection, Collection *collection)
virtual void build_rigidbody(Scene *scene)
virtual void build_empty_object(Object *object)
virtual void build_object_transform(Object *object)
virtual void build_light_linking_collection(Collection *collection)
static void modifier_walk(void *user_data, struct Object *object, struct ID **idpoin, LibraryForeachIDCallbackFlag cb_flag)
virtual void build_freestyle_lineset(FreestyleLineSet *fls)
virtual void build_movieclip(MovieClip *clip)
T * get_cow_datablock(const T *orig) const
virtual void build_object_data_light(Object *object)
virtual void build_ik_pose(Object *object, bPoseChannel *pchan, bConstraint *con)
virtual void build_scene_render(Scene *scene, ViewLayer *view_layer)
virtual void build_image(Image *image)
virtual void build_speaker(Speaker *speaker)
virtual void build_sound(bSound *sound)
Vector< PersistentOperationKey > needs_update_operations_
virtual void build_object_data_geometry_datablock(ID *obdata)
DepsgraphNodeBuilder(Main *bmain, Depsgraph *graph, DepsgraphBuilderCache *cache)
Vector< PersistentOperationKey > saved_entry_tags_
virtual void build_object_flags(int base_index, Object *object, eDepsNode_LinkedState_Type linked_state)
ID * get_cow_id(const ID *id_orig) const
virtual void build_rig(Object *object)
virtual void build_lightprobe(LightProbe *probe)
virtual void build_nodetree(bNodeTree *ntree)
virtual void build_splineik_pose(Object *object, bPoseChannel *pchan, bConstraint *con)
virtual void build_idproperties(IDProperty *id_property)
virtual void build_camera(Camera *camera)
virtual void build_light(Light *lamp)
virtual void build_layer_collections(ListBaseT< LayerCollection > *lb)
virtual void build_driver(ID *id, FCurve *fcurve, int driver_index)
virtual void build_object_light_linking(Object *object)
bool has_operation_node(ID *id, NodeType comp_type, const char *comp_name, OperationCode opcode, const char *name="", int name_tag=-1)
virtual void build_view_layer(Scene *scene, ViewLayer *view_layer, eDepsNode_LinkedState_Type linked_state)
virtual void build_nodetree_socket(bNodeSocket *socket)
virtual void build_scene_compositor(Scene *scene)
virtual void build_object_data_lightprobe(Object *object)
virtual void build_animdata_drivers(ID *id, AnimData *adt)
virtual void build_object_data_grease_pencil(Object *object)
virtual void build_object_constraints(Object *object)
virtual void build_object_shading(Object *object)
virtual void build_object_modifiers(Object *object)
virtual void build_object_from_layer(int base_index, Object *object, eDepsNode_LinkedState_Type linked_state)
void camera(KernelGlobals &kg, const ShadingData &sd, float3 &outview, float &outdepth, float &outdist)
#define T
uint64_t IDComponentsMask
std::function< void(blender::Depsgraph *)> DepsEvalOperationCb
static int foreach_id_cow_detect_need_for_update_callback(LibraryIDLinkCallbackData *cb_data)
BMesh Iterators.
unsigned int uint32_t
Definition BKE_text.h:81
LibraryForeachIDCallbackFlag