Refactor CDData masks, to have one mask per mesh elem type.

We already have different storages for cddata of verts, edges etc.,
'simply' do the same for the mask flags we use all around Blender code
to request some data, or limit some operation to some layers, etc.

Reason we need this is that some cddata types (like Normals) are
actually shared between verts/polys/loops, and we don’t want to generate
clnors everytime we request vnors!

As a side note, this also does final fix to T59338, which was the
trigger for this patch (need to request computed loop normals for
another mesh than evaluated one).

Reviewers: brecht, campbellbarton, sergey

Differential Revision: https://developer.blender.org/D4407

6 files changed, 24 insertions, 15 deletions

diff --git a/source/blender/depsgraph/intern/builder/deg_builder.cc b/source/blender/depsgraph/intern/builder/deg_builder.cc
index ca454610f1e..b6e516ee9b4 100644
--- a/source/blender/depsgraph/intern/builder/deg_builder.cc
+++ b/source/blender/depsgraph/intern/builder/deg_builder.cc
@@ -203,7 +203,7 @@ void deg_graph_build_finalize(Main *bmain, Depsgraph *graph)
 			flag |= ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY;
 		}
 		/* Tag rebuild if the custom data mask changed. */
-		if (id_node->customdata_mask != id_node->previous_customdata_mask) {
+		if (id_node->customdata_masks != id_node->previous_customdata_masks) {
 			flag |= ID_RECALC_GEOMETRY;
 		}
 		if (!deg_copy_on_write_is_expanded(id_node->id_cow)) {
diff --git a/source/blender/depsgraph/intern/builder/deg_builder_nodes.cc b/source/blender/depsgraph/intern/builder/deg_builder_nodes.cc
index 463f4fa0935..dbf6b1d1451 100644
--- a/source/blender/depsgraph/intern/builder/deg_builder_nodes.cc
+++ b/source/blender/depsgraph/intern/builder/deg_builder_nodes.cc
@@ -154,14 +154,14 @@ IDNode *DepsgraphNodeBuilder::add_id_node(ID *id)
 	ID *id_cow = NULL;
 	IDComponentsMask previously_visible_components_mask = 0;
 	uint32_t previous_eval_flags = 0;
-	uint64_t previous_customdata_mask = 0;
+	DEGCustomDataMeshMasks previous_customdata_masks;
 	IDInfo *id_info = (IDInfo *)BLI_ghash_lookup(id_info_hash_, id);
 	if (id_info != NULL) {
 		id_cow = id_info->id_cow;
 		previously_visible_components_mask =
 		        id_info->previously_visible_components_mask;
 		previous_eval_flags = id_info->previous_eval_flags;
-		previous_customdata_mask = id_info->previous_customdata_mask;
+		previous_customdata_masks = id_info->previous_customdata_masks;
 		/* Tag ID info to not free the CoW ID pointer. */
 		id_info->id_cow = NULL;
 	}
@@ -169,7 +169,7 @@ IDNode *DepsgraphNodeBuilder::add_id_node(ID *id)
 	id_node->previously_visible_components_mask =
 	        previously_visible_components_mask;
 	id_node->previous_eval_flags = previous_eval_flags;
-	id_node->previous_customdata_mask = previous_customdata_mask;
+	id_node->previous_customdata_masks = previous_customdata_masks;
 	/* Currently all ID nodes are supposed to have copy-on-write logic.
 	 *
 	 * NOTE: Zero number of components indicates that ID node was just created. */
@@ -339,7 +339,7 @@ void DepsgraphNodeBuilder::begin_build()
 		id_info->previously_visible_components_mask =
 		        id_node->visible_components_mask;
 		id_info->previous_eval_flags = id_node->eval_flags;
-		id_info->previous_customdata_mask = id_node->customdata_mask;
+		id_info->previous_customdata_masks = id_node->customdata_masks;
 		BLI_ghash_insert(id_info_hash_, id_node->id_orig, id_info);
 		id_node->id_cow = NULL;
 	}
diff --git a/source/blender/depsgraph/intern/builder/deg_builder_nodes.h b/source/blender/depsgraph/intern/builder/deg_builder_nodes.h
index 0bf4c13d515..d5d1ac2d33a 100644
--- a/source/blender/depsgraph/intern/builder/deg_builder_nodes.h
+++ b/source/blender/depsgraph/intern/builder/deg_builder_nodes.h
@@ -230,7 +230,7 @@ public:
 		/* Special evaluation flag mask from the previous depsgraph. */
 		uint32_t previous_eval_flags;
 		/* Mesh CustomData mask from the previous depsgraph. */
-		uint64_t previous_customdata_mask;
+		DEGCustomDataMeshMasks previous_customdata_masks;
 	};
 
 protected:
diff --git a/source/blender/depsgraph/intern/builder/deg_builder_relations.cc b/source/blender/depsgraph/intern/builder/deg_builder_relations.cc
index 9aab90f88cf..161d0a9cd9f 100644
--- a/source/blender/depsgraph/intern/builder/deg_builder_relations.cc
+++ b/source/blender/depsgraph/intern/builder/deg_builder_relations.cc
@@ -309,16 +309,18 @@ void DepsgraphRelationBuilder::add_modifier_to_transform_relation(
 	        transform_operation_node, geometry_operation_node, description);
 }
 
-void DepsgraphRelationBuilder::add_customdata_mask(Object *object, uint64_t mask)
+void DepsgraphRelationBuilder::add_customdata_mask(
+        Object *object,
+        const DEGCustomDataMeshMasks &customdata_masks)
 {
-	if (mask != 0 && object != NULL && object->type == OB_MESH) {
+	if (customdata_masks != DEGCustomDataMeshMasks() && object != NULL && object->type == OB_MESH) {
 		DEG::IDNode *id_node = graph_->find_id_node(&object->id);
 
 		if (id_node == NULL) {
 			BLI_assert(!"ID should always be valid");
 		}
 		else {
-			id_node->customdata_mask |= mask;
+			id_node->customdata_masks |= customdata_masks;
 		}
 	}
 }
@@ -864,7 +866,11 @@ void DepsgraphRelationBuilder::build_object_parent(Object *object)
 			 * TODO(sergey): This optimization got lost at 2.8, so either verify
 			 * we can get rid of this mask here, or bring the optimization
 			 * back. */
-			add_customdata_mask(object->parent, CD_MASK_ORIGINDEX);
+			add_customdata_mask(object->parent,
+			                    DEGCustomDataMeshMasks::MaskVert(CD_MASK_ORIGINDEX) |
+			                    DEGCustomDataMeshMasks::MaskEdge(CD_MASK_ORIGINDEX) |
+			                    DEGCustomDataMeshMasks::MaskFace(CD_MASK_ORIGINDEX) |
+			                    DEGCustomDataMeshMasks::MaskPoly(CD_MASK_ORIGINDEX));
 			ComponentKey transform_key(parent_id, NodeType::TRANSFORM);
 			add_relation(transform_key, ob_key, "Vertex Parent TFM");
 			break;
@@ -1118,7 +1124,7 @@ void DepsgraphRelationBuilder::build_constraints(ID *id,
 					        target_transform_key, constraint_op_key, cti->name);
 					add_relation(
 					        target_geometry_key, constraint_op_key, cti->name);
-					add_customdata_mask(ct->tar, CD_MASK_MDEFORMVERT);
+					add_customdata_mask(ct->tar, DEGCustomDataMeshMasks::MaskVert(CD_MASK_MDEFORMVERT));
 				}
 				else if (con->type == CONSTRAINT_TYPE_SHRINKWRAP) {
 					bShrinkwrapConstraint *scon = (bShrinkwrapConstraint *) con->data;
@@ -1131,7 +1137,9 @@ void DepsgraphRelationBuilder::build_constraints(ID *id,
 					if (ct->tar->type == OB_MESH && scon->shrinkType != MOD_SHRINKWRAP_NEAREST_VERTEX) {
 						bool track = (scon->flag & CON_SHRINKWRAP_TRACK_NORMAL) != 0;
 						if (track || BKE_shrinkwrap_needs_normals(scon->shrinkType, scon->shrinkMode)) {
-							add_customdata_mask(ct->tar, CD_MASK_NORMAL | CD_MASK_CUSTOMLOOPNORMAL);
+							add_customdata_mask(ct->tar,
+							                    DEGCustomDataMeshMasks::MaskVert(CD_MASK_NORMAL) |
+							                    DEGCustomDataMeshMasks::MaskLoop(CD_MASK_CUSTOMLOOPNORMAL));
 						}
 						if (scon->shrinkType == MOD_SHRINKWRAP_TARGET_PROJECT) {
 							add_special_eval_flag(&ct->tar->id, DAG_EVAL_NEED_SHRINKWRAP_BOUNDARY);
diff --git a/source/blender/depsgraph/intern/builder/deg_builder_relations.h b/source/blender/depsgraph/intern/builder/deg_builder_relations.h
index fb76b469572..250593eeda0 100644
--- a/source/blender/depsgraph/intern/builder/deg_builder_relations.h
+++ b/source/blender/depsgraph/intern/builder/deg_builder_relations.h
@@ -204,7 +204,8 @@ public:
 	void add_modifier_to_transform_relation(const DepsNodeHandle *handle,
 	                                        const char *description);
 
-	void add_customdata_mask(Object *object, uint64_t mask);
+	void add_customdata_mask(Object *object,
+	                         const DEGCustomDataMeshMasks &customdata_masks);
 	void add_special_eval_flag(ID *object, uint32_t flag);
 
 	void build_id(ID *id);
diff --git a/source/blender/depsgraph/intern/builder/deg_builder_relations_rig.cc b/source/blender/depsgraph/intern/builder/deg_builder_relations_rig.cc
index 8742dc43651..fe88b532dca 100644
--- a/source/blender/depsgraph/intern/builder/deg_builder_relations_rig.cc
+++ b/source/blender/depsgraph/intern/builder/deg_builder_relations_rig.cc
@@ -130,7 +130,7 @@ void DepsgraphRelationBuilder::build_ik_pose(Object *object,
 			 * separately. */
 			ComponentKey target_key(&data->tar->id, NodeType::GEOMETRY);
 			add_relation(target_key, solver_key, con->name);
-			add_customdata_mask(data->tar, CD_MASK_MDEFORMVERT);
+			add_customdata_mask(data->tar, DEGCustomDataMeshMasks::MaskVert(CD_MASK_MDEFORMVERT));
 		}
 		else {
 			/* Standard Object Target. */
@@ -160,7 +160,7 @@ void DepsgraphRelationBuilder::build_ik_pose(Object *object,
 			 * separately. */
 			ComponentKey target_key(&data->poletar->id, NodeType::GEOMETRY);
 			add_relation(target_key, solver_key, con->name);
-			add_customdata_mask(data->poletar, CD_MASK_MDEFORMVERT);
+			add_customdata_mask(data->poletar, DEGCustomDataMeshMasks::MaskVert(CD_MASK_MDEFORMVERT));
 		}
 		else {
 			ComponentKey target_key(&data->poletar->id, NodeType::TRANSFORM);