Fix T81925: incorrectly skipped string copy in test_env_path
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_nodes.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 "intern/builder/deg_builder.h"
27 #include "intern/builder/deg_builder_map.h"
28 #include "intern/depsgraph_type.h"
29 #include "intern/node/deg_node_id.h"
30 #include "intern/node/deg_node_operation.h"
31
32 #include "DEG_depsgraph.h"
33
34 struct CacheFile;
35 struct Camera;
36 struct Collection;
37 struct FCurve;
38 struct FreestyleLineSet;
39 struct FreestyleLineStyle;
40 struct ID;
41 struct IDProperty;
42 struct Image;
43 struct Key;
44 struct LayerCollection;
45 struct Light;
46 struct LightProbe;
47 struct ListBase;
48 struct Main;
49 struct Mask;
50 struct Material;
51 struct MovieClip;
52 struct Object;
53 struct ParticleSettings;
54 struct Scene;
55 struct Simulation;
56 struct Speaker;
57 struct Tex;
58 struct World;
59 struct bAction;
60 struct bArmature;
61 struct bConstraint;
62 struct bGPdata;
63 struct bNodeSocket;
64 struct bNodeTree;
65 struct bPoseChannel;
66 struct bSound;
67
68 namespace blender {
69 namespace deg {
70
71 struct ComponentNode;
72 struct Depsgraph;
73 class DepsgraphBuilderCache;
74 struct IDNode;
75 struct OperationNode;
76 struct TimeSourceNode;
77
78 class DepsgraphNodeBuilder : public DepsgraphBuilder {
79  public:
80   DepsgraphNodeBuilder(Main *bmain, Depsgraph *graph, DepsgraphBuilderCache *cache);
81   ~DepsgraphNodeBuilder();
82
83   /* For given original ID get ID which is created by CoW system. */
84   ID *get_cow_id(const ID *id_orig) const;
85   /* Similar to above, but for the cases when there is no ID node we create
86    * one. */
87   ID *ensure_cow_id(ID *id_orig);
88
89   /* Helper wrapper function which wraps get_cow_id with a needed type cast. */
90   template<typename T> T *get_cow_datablock(const T *orig) const
91   {
92     return (T *)get_cow_id(&orig->id);
93   }
94
95   /* For a given COW datablock get corresponding original one. */
96   template<typename T> T *get_orig_datablock(const T *cow) const
97   {
98     return (T *)cow->id.orig_id;
99   }
100
101   virtual void begin_build();
102   virtual void end_build();
103
104   IDNode *add_id_node(ID *id);
105   IDNode *find_id_node(ID *id);
106   TimeSourceNode *add_time_source();
107
108   ComponentNode *add_component_node(ID *id, NodeType comp_type, const char *comp_name = "");
109
110   OperationNode *add_operation_node(ComponentNode *comp_node,
111                                     OperationCode opcode,
112                                     const DepsEvalOperationCb &op = nullptr,
113                                     const char *name = "",
114                                     int name_tag = -1);
115   OperationNode *add_operation_node(ID *id,
116                                     NodeType comp_type,
117                                     const char *comp_name,
118                                     OperationCode opcode,
119                                     const DepsEvalOperationCb &op = nullptr,
120                                     const char *name = "",
121                                     int name_tag = -1);
122   OperationNode *add_operation_node(ID *id,
123                                     NodeType comp_type,
124                                     OperationCode opcode,
125                                     const DepsEvalOperationCb &op = nullptr,
126                                     const char *name = "",
127                                     int name_tag = -1);
128
129   OperationNode *ensure_operation_node(ID *id,
130                                        NodeType comp_type,
131                                        OperationCode opcode,
132                                        const DepsEvalOperationCb &op = nullptr,
133                                        const char *name = "",
134                                        int name_tag = -1);
135
136   bool has_operation_node(ID *id,
137                           NodeType comp_type,
138                           const char *comp_name,
139                           OperationCode opcode,
140                           const char *name = "",
141                           int name_tag = -1);
142
143   OperationNode *find_operation_node(ID *id,
144                                      NodeType comp_type,
145                                      const char *comp_name,
146                                      OperationCode opcode,
147                                      const char *name = "",
148                                      int name_tag = -1);
149
150   OperationNode *find_operation_node(
151       ID *id, NodeType comp_type, OperationCode opcode, const char *name = "", int name_tag = -1);
152
153   virtual void build_id(ID *id);
154
155   virtual void build_idproperties(IDProperty *id_property);
156
157   virtual void build_scene_render(Scene *scene, ViewLayer *view_layer);
158   virtual void build_scene_parameters(Scene *scene);
159   virtual void build_scene_compositor(Scene *scene);
160
161   virtual void build_layer_collections(ListBase *lb);
162   virtual void build_view_layer(Scene *scene,
163                                 ViewLayer *view_layer,
164                                 eDepsNode_LinkedState_Type linked_state);
165   virtual void build_collection(LayerCollection *from_layer_collection, Collection *collection);
166   virtual void build_object(int base_index,
167                             Object *object,
168                             eDepsNode_LinkedState_Type linked_state,
169                             bool is_visible);
170   virtual void build_object_proxy_from(Object *object, bool is_object_visible);
171   virtual void build_object_proxy_group(Object *object, bool is_object_visible);
172   virtual void build_object_instance_collection(Object *object, bool is_object_visible);
173   virtual void build_object_from_layer(int base_index,
174                                        Object *object,
175                                        eDepsNode_LinkedState_Type linked_state);
176   virtual void build_object_flags(int base_index,
177                                   Object *object,
178                                   eDepsNode_LinkedState_Type linked_state);
179   virtual void build_object_data(Object *object, bool is_object_visible);
180   virtual void build_object_data_camera(Object *object);
181   virtual void build_object_data_geometry(Object *object, bool is_object_visible);
182   virtual void build_object_data_geometry_datablock(ID *obdata, bool is_object_visible);
183   virtual void build_object_data_light(Object *object);
184   virtual void build_object_data_lightprobe(Object *object);
185   virtual void build_object_data_speaker(Object *object);
186   virtual void build_object_transform(Object *object);
187   virtual void build_object_constraints(Object *object);
188   virtual void build_object_pointcache(Object *object);
189   virtual void build_pose_constraints(Object *object,
190                                       bPoseChannel *pchan,
191                                       int pchan_index,
192                                       bool is_object_visible);
193   virtual void build_rigidbody(Scene *scene);
194   virtual void build_particle_systems(Object *object, bool is_object_visible);
195   virtual void build_particle_settings(ParticleSettings *part);
196   virtual void build_animdata(ID *id);
197   virtual void build_animdata_nlastrip_targets(ListBase *strips);
198   virtual void build_animation_images(ID *id);
199   virtual void build_action(bAction *action);
200   virtual void build_driver(ID *id, FCurve *fcurve, int driver_index);
201   virtual void build_driver_variables(ID *id, FCurve *fcurve);
202   virtual void build_driver_id_property(ID *id, const char *rna_path);
203   virtual void build_parameters(ID *id);
204   virtual void build_dimensions(Object *object);
205   virtual void build_ik_pose(Object *object, bPoseChannel *pchan, bConstraint *con);
206   virtual void build_splineik_pose(Object *object, bPoseChannel *pchan, bConstraint *con);
207   virtual void build_rig(Object *object, bool is_object_visible);
208   virtual void build_proxy_rig(Object *object, bool is_object_visible);
209   virtual void build_armature(bArmature *armature);
210   virtual void build_armature_bones(ListBase *bones);
211   virtual void build_shapekeys(Key *key);
212   virtual void build_camera(Camera *camera);
213   virtual void build_light(Light *lamp);
214   virtual void build_nodetree(bNodeTree *ntree);
215   virtual void build_nodetree_socket(bNodeSocket *socket);
216   virtual void build_material(Material *ma);
217   virtual void build_materials(Material **materials, int num_materials);
218   virtual void build_freestyle_lineset(FreestyleLineSet *fls);
219   virtual void build_freestyle_linestyle(FreestyleLineStyle *linestyle);
220   virtual void build_texture(Tex *tex);
221   virtual void build_image(Image *image);
222   virtual void build_world(World *world);
223   virtual void build_gpencil(bGPdata *gpd);
224   virtual void build_cachefile(CacheFile *cache_file);
225   virtual void build_mask(Mask *mask);
226   virtual void build_movieclip(MovieClip *clip);
227   virtual void build_lightprobe(LightProbe *probe);
228   virtual void build_speaker(Speaker *speaker);
229   virtual void build_sound(bSound *sound);
230   virtual void build_simulation(Simulation *simulation);
231   virtual void build_scene_sequencer(Scene *scene);
232   virtual void build_scene_audio(Scene *scene);
233   virtual void build_scene_speakers(Scene *scene, ViewLayer *view_layer);
234
235   /* Per-ID information about what was already in the dependency graph.
236    * Allows to re-use certain values, to speed up following evaluation. */
237   struct IDInfo {
238     /* Copy-on-written pointer of the corresponding ID. */
239     ID *id_cow;
240     /* Mask of visible components from previous state of the
241      * dependency graph. */
242     IDComponentsMask previously_visible_components_mask;
243     /* Special evaluation flag mask from the previous depsgraph. */
244     uint32_t previous_eval_flags;
245     /* Mesh CustomData mask from the previous depsgraph. */
246     DEGCustomDataMeshMasks previous_customdata_masks;
247   };
248
249  protected:
250   /* Allows to identify an operation which was tagged for update at the time
251    * relations are being updated. We can not reuse operation node pointer
252    * since it will change during dependency graph construction. */
253   struct SavedEntryTag {
254     ID *id_orig;
255     NodeType component_type;
256     OperationCode opcode;
257     string name;
258     int name_tag;
259   };
260   Vector<SavedEntryTag> saved_entry_tags_;
261
262   struct BuilderWalkUserData {
263     DepsgraphNodeBuilder *builder;
264     /* Denotes whether object the walk is invoked from is visible. */
265     bool is_parent_visible;
266   };
267   static void modifier_walk(void *user_data,
268                             struct Object *object,
269                             struct ID **idpoin,
270                             int cb_flag);
271   static void constraint_walk(bConstraint *constraint,
272                               ID **idpoin,
273                               bool is_reference,
274                               void *user_data);
275
276   /* State which demotes currently built entities. */
277   Scene *scene_;
278   ViewLayer *view_layer_;
279   int view_layer_index_;
280   /* NOTE: Collection are possibly built recursively, so be careful when
281    * setting the current state. */
282   Collection *collection_;
283   /* Accumulated flag over the hierarchy of currently building collections.
284    * Denotes whether all the hierarchy from parent of collection_ to the
285    * very root is visible (aka not restricted.). */
286   bool is_parent_collection_visible_;
287
288   /* Indexed by original ID, values are IDInfo. */
289   Map<const ID *, IDInfo *> id_info_hash_;
290
291   /* Set of IDs which were already build. Makes it easier to keep track of
292    * what was already built and what was not. */
293   BuilderMap built_map_;
294 };
295
296 }  // namespace deg
297 }  // namespace blender