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