Merge branch 'blender-v2.81-release'
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_relations.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup depsgraph
22  */
23
24 #pragma once
25
26 #include <cstdio>
27 #include <cstring>
28
29 #include "intern/depsgraph_type.h"
30
31 #include "DNA_ID.h"
32
33 #include "RNA_access.h"
34 #include "RNA_types.h"
35
36 #include "BLI_utildefines.h"
37 #include "BLI_string.h"
38
39 #include "intern/builder/deg_builder.h"
40 #include "intern/builder/deg_builder_map.h"
41 #include "intern/builder/deg_builder_rna.h"
42 #include "intern/depsgraph.h"
43 #include "intern/node/deg_node.h"
44 #include "intern/node/deg_node_id.h"
45 #include "intern/node/deg_node_component.h"
46 #include "intern/node/deg_node_operation.h"
47
48 struct Base;
49 struct CacheFile;
50 struct Camera;
51 struct Collection;
52 struct EffectorWeights;
53 struct FCurve;
54 struct ID;
55 struct Image;
56 struct Key;
57 struct LayerCollection;
58 struct Light;
59 struct LightProbe;
60 struct ListBase;
61 struct Main;
62 struct Mask;
63 struct Material;
64 struct MovieClip;
65 struct Object;
66 struct ParticleSettings;
67 struct ParticleSystem;
68 struct Scene;
69 struct Speaker;
70 struct Tex;
71 struct ViewLayer;
72 struct World;
73 struct bAction;
74 struct bArmature;
75 struct bConstraint;
76 struct bGPdata;
77 struct bNodeTree;
78 struct bPoseChannel;
79 struct bSound;
80
81 struct PropertyRNA;
82
83 namespace DEG {
84
85 struct ComponentNode;
86 struct DepsNodeHandle;
87 struct Depsgraph;
88 class DepsgraphBuilderCache;
89 struct IDNode;
90 struct Node;
91 struct OperationNode;
92 struct Relation;
93 struct RootPChanMap;
94 struct TimeSourceNode;
95
96 struct TimeSourceKey {
97   TimeSourceKey();
98   TimeSourceKey(ID *id);
99
100   string identifier() const;
101
102   ID *id;
103 };
104
105 struct ComponentKey {
106   ComponentKey();
107   ComponentKey(ID *id, NodeType type, const char *name = "");
108
109   string identifier() const;
110
111   ID *id;
112   NodeType type;
113   const char *name;
114 };
115
116 struct OperationKey {
117   OperationKey();
118   OperationKey(ID *id, NodeType component_type, const char *name, int name_tag = -1);
119   OperationKey(
120       ID *id, NodeType component_type, const char *component_name, const char *name, int name_tag);
121
122   OperationKey(ID *id, NodeType component_type, OperationCode opcode);
123   OperationKey(ID *id, NodeType component_type, const char *component_name, OperationCode opcode);
124
125   OperationKey(
126       ID *id, NodeType component_type, OperationCode opcode, const char *name, int name_tag = -1);
127   OperationKey(ID *id,
128                NodeType component_type,
129                const char *component_name,
130                OperationCode opcode,
131                const char *name,
132                int name_tag = -1);
133
134   string identifier() const;
135
136   ID *id;
137   NodeType component_type;
138   const char *component_name;
139   OperationCode opcode;
140   const char *name;
141   int name_tag;
142 };
143
144 struct RNAPathKey {
145   RNAPathKey(ID *id, const char *path, RNAPointerSource source);
146   RNAPathKey(ID *id, const PointerRNA &ptr, PropertyRNA *prop, RNAPointerSource source);
147
148   string identifier() const;
149
150   ID *id;
151   PointerRNA ptr;
152   PropertyRNA *prop;
153   RNAPointerSource source;
154 };
155
156 class DepsgraphRelationBuilder : public DepsgraphBuilder {
157  public:
158   DepsgraphRelationBuilder(Main *bmain, Depsgraph *graph, DepsgraphBuilderCache *cache);
159
160   void begin_build();
161
162   template<typename KeyFrom, typename KeyTo>
163   Relation *add_relation(const KeyFrom &key_from,
164                          const KeyTo &key_to,
165                          const char *description,
166                          int flags = 0);
167
168   template<typename KeyTo>
169   Relation *add_relation(const TimeSourceKey &key_from,
170                          const KeyTo &key_to,
171                          const char *description,
172                          int flags = 0);
173
174   template<typename KeyType>
175   Relation *add_node_handle_relation(const KeyType &key_from,
176                                      const DepsNodeHandle *handle,
177                                      const char *description,
178                                      int flags = 0);
179
180   template<typename KeyTo>
181   Relation *add_depends_on_transform_relation(ID *id,
182                                               const KeyTo &key_to,
183                                               const char *description,
184                                               int flags = 0);
185
186   /* Adds relation from proper transformation operation to the modifier.
187    * Takes care of checking for possible physics solvers modifying position
188    * of this object. */
189   void add_modifier_to_transform_relation(const DepsNodeHandle *handle, const char *description);
190
191   void add_customdata_mask(Object *object, const DEGCustomDataMeshMasks &customdata_masks);
192   void add_special_eval_flag(ID *object, uint32_t flag);
193
194   virtual void build_id(ID *id);
195
196   virtual void build_scene_render(Scene *scene, ViewLayer *view_layer);
197   virtual void build_scene_parameters(Scene *scene);
198   virtual void build_scene_compositor(Scene *scene);
199
200   virtual void build_layer_collections(ListBase *lb);
201   virtual void build_view_layer(Scene *scene,
202                                 ViewLayer *view_layer,
203                                 eDepsNode_LinkedState_Type linked_state);
204   virtual void build_collection(LayerCollection *from_layer_collection,
205                                 Object *object,
206                                 Collection *collection);
207   virtual void build_object(Base *base, Object *object);
208   virtual void build_object_proxy_from(Object *object);
209   virtual void build_object_proxy_group(Object *object);
210   virtual void build_object_flags(Base *base, Object *object);
211   virtual void build_object_data(Object *object);
212   virtual void build_object_data_camera(Object *object);
213   virtual void build_object_data_geometry(Object *object);
214   virtual void build_object_data_geometry_datablock(ID *obdata);
215   virtual void build_object_data_light(Object *object);
216   virtual void build_object_data_lightprobe(Object *object);
217   virtual void build_object_data_speaker(Object *object);
218   virtual void build_object_parent(Object *object);
219   virtual void build_object_pointcache(Object *object);
220   virtual void build_constraints(ID *id,
221                                  NodeType component_type,
222                                  const char *component_subdata,
223                                  ListBase *constraints,
224                                  RootPChanMap *root_map);
225   virtual void build_animdata(ID *id);
226   virtual void build_animdata_curves(ID *id);
227   virtual void build_animdata_curves_targets(ID *id,
228                                              ComponentKey &adt_key,
229                                              OperationNode *operation_from,
230                                              ListBase *curves);
231   virtual void build_animdata_nlastrip_targets(ID *id,
232                                                ComponentKey &adt_key,
233                                                OperationNode *operation_from,
234                                                ListBase *strips);
235   virtual void build_animdata_drivers(ID *id);
236   virtual void build_animation_images(ID *id);
237   virtual void build_action(bAction *action);
238   virtual void build_driver(ID *id, FCurve *fcurve);
239   virtual void build_driver_data(ID *id, FCurve *fcurve);
240   virtual void build_driver_variables(ID *id, FCurve *fcurve);
241   virtual void build_driver_id_property(ID *id, const char *rna_path);
242   virtual void build_parameters(ID *id);
243   virtual void build_world(World *world);
244   virtual void build_rigidbody(Scene *scene);
245   virtual void build_particle_systems(Object *object);
246   virtual void build_particle_settings(ParticleSettings *part);
247   virtual void build_particle_system_visualization_object(Object *object,
248                                                           ParticleSystem *psys,
249                                                           Object *draw_object);
250   virtual void build_ik_pose(Object *object,
251                              bPoseChannel *pchan,
252                              bConstraint *con,
253                              RootPChanMap *root_map);
254   virtual void build_splineik_pose(Object *object,
255                                    bPoseChannel *pchan,
256                                    bConstraint *con,
257                                    RootPChanMap *root_map);
258   virtual void build_rig(Object *object);
259   virtual void build_proxy_rig(Object *object);
260   virtual void build_shapekeys(Key *key);
261   virtual void build_armature(bArmature *armature);
262   virtual void build_camera(Camera *camera);
263   virtual void build_light(Light *lamp);
264   virtual void build_nodetree(bNodeTree *ntree);
265   virtual void build_material(Material *ma);
266   virtual void build_materials(Material **materials, int num_materials);
267   virtual void build_texture(Tex *tex);
268   virtual void build_image(Image *image);
269   virtual void build_gpencil(bGPdata *gpd);
270   virtual void build_cachefile(CacheFile *cache_file);
271   virtual void build_mask(Mask *mask);
272   virtual void build_movieclip(MovieClip *clip);
273   virtual void build_lightprobe(LightProbe *probe);
274   virtual void build_speaker(Speaker *speaker);
275   virtual void build_sound(bSound *sound);
276   virtual void build_scene_sequencer(Scene *scene);
277   virtual void build_scene_audio(Scene *scene);
278   virtual void build_scene_speakers(Scene *scene, ViewLayer *view_layer);
279
280   virtual void build_nested_datablock(ID *owner, ID *id);
281   virtual void build_nested_nodetree(ID *owner, bNodeTree *ntree);
282   virtual void build_nested_shapekey(ID *owner, Key *key);
283
284   void add_particle_collision_relations(const OperationKey &key,
285                                         Object *object,
286                                         Collection *collection,
287                                         const char *name);
288   void add_particle_forcefield_relations(const OperationKey &key,
289                                          Object *object,
290                                          ParticleSystem *psys,
291                                          EffectorWeights *eff,
292                                          bool add_absorption,
293                                          const char *name);
294
295   virtual void build_copy_on_write_relations();
296   virtual void build_copy_on_write_relations(IDNode *id_node);
297
298   template<typename KeyType> OperationNode *find_operation_node(const KeyType &key);
299
300   Depsgraph *getGraph();
301
302  protected:
303   TimeSourceNode *get_node(const TimeSourceKey &key) const;
304   ComponentNode *get_node(const ComponentKey &key) const;
305   OperationNode *get_node(const OperationKey &key) const;
306   Node *get_node(const RNAPathKey &key);
307
308   OperationNode *find_node(const OperationKey &key) const;
309   bool has_node(const OperationKey &key) const;
310
311   Relation *add_time_relation(TimeSourceNode *timesrc,
312                               Node *node_to,
313                               const char *description,
314                               int flags = 0);
315   Relation *add_operation_relation(OperationNode *node_from,
316                                    OperationNode *node_to,
317                                    const char *description,
318                                    int flags = 0);
319
320   template<typename KeyType>
321   DepsNodeHandle create_node_handle(const KeyType &key, const char *default_name = "");
322
323   /* TODO(sergey): All those is_same* functions are to be generalized. */
324
325   /* Check whether two keys corresponds to the same bone from same armature.
326    *
327    * This is used by drivers relations builder to avoid possible fake
328    * dependency cycle when one bone property drives another property of the
329    * same bone. */
330   template<typename KeyFrom, typename KeyTo>
331   bool is_same_bone_dependency(const KeyFrom &key_from, const KeyTo &key_to);
332
333   /* Similar to above, but used to check whether driver is using node from
334    * the same node tree as a driver variable. */
335   template<typename KeyFrom, typename KeyTo>
336   bool is_same_nodetree_node_dependency(const KeyFrom &key_from, const KeyTo &key_to);
337
338  private:
339   struct BuilderWalkUserData {
340     DepsgraphRelationBuilder *builder;
341   };
342
343   static void modifier_walk(void *user_data,
344                             struct Object *object,
345                             struct ID **idpoin,
346                             int cb_flag);
347
348   static void constraint_walk(bConstraint *con, ID **idpoin, bool is_reference, void *user_data);
349
350   /* State which demotes currently built entities. */
351   Scene *scene_;
352
353   BuilderMap built_map_;
354   RNANodeQuery rna_node_query_;
355 };
356
357 struct DepsNodeHandle {
358   DepsNodeHandle(DepsgraphRelationBuilder *builder,
359                  OperationNode *node,
360                  const char *default_name = "")
361       : builder(builder), node(node), default_name(default_name)
362   {
363     BLI_assert(node != NULL);
364   }
365
366   DepsgraphRelationBuilder *builder;
367   OperationNode *node;
368   const char *default_name;
369 };
370
371 }  // namespace DEG
372
373 #include "intern/builder/deg_builder_relations_impl.h"