Objects: support for hiding all objects in a collection.

In the outliner there are now icons for it, Ctrl+Click isolates a
single collections.

In the 3D view, Ctrl+H key opens a menu that is more or less the
equivalent of the old layer buttons in the header. Regular Click isolates
the collection, Shift+Click toggle the collection visibility. Pressing
number keys and letters works in this menu, which can help for quickly
selecting a specific collection.

Shortcuts for quick switching by just pressing 1/2/3/.. keys are available
again. The order can be confusing with nested collections, but that seems
unavoidable. The first numbers control the top level collections, and then
sub collections if numbers are left.

Remaining design issues:

* The 3D view menu needs to be improved: support for sub collections,
  staying open on shift+click, access from the 3D view header somewhere,
  shortcut key display.
* Currently collection hiding just controls per-object hiding, we plan
  to separate this state still so alt+H doesn't affect collection hiding.

3 files changed, 120 insertions, 6 deletions

diff --git a/source/blender/editors/object/object_edit.c b/source/blender/editors/object/object_edit.c
index 715e6413d42..f050297ee2f 100644
--- a/source/blender/editors/object/object_edit.c
+++ b/source/blender/editors/object/object_edit.c
@@ -201,7 +201,8 @@ void OBJECT_OT_hide_view_clear(wmOperatorType *ot)
 	/* flags */
 	ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 
-	RNA_def_boolean(ot->srna, "select", false, "Select", "");
+	PropertyRNA *prop = RNA_def_boolean(ot->srna, "select", false, "Select", "");
+	RNA_def_property_flag(prop, PROP_SKIP_SAVE | PROP_HIDDEN);
 }
 
 static int object_hide_view_set_exec(bContext *C, wmOperator *op)
@@ -257,7 +258,115 @@ void OBJECT_OT_hide_view_set(wmOperatorType *ot)
 	/* flags */
 	ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 
-	RNA_def_boolean(ot->srna, "unselected", 0, "Unselected", "Hide unselected rather than selected objects");
+	PropertyRNA *prop;
+	prop = RNA_def_boolean(ot->srna, "unselected", 0, "Unselected", "Hide unselected rather than selected objects");
+	RNA_def_property_flag(prop, PROP_SKIP_SAVE | PROP_HIDDEN);
+}
+
+static int object_hide_collection_exec(bContext *C, wmOperator *op)
+{
+	int index = RNA_int_get(op->ptr, "collection_index");
+	bool extend = (CTX_wm_window(C)->eventstate->shift != 0);
+
+	if (CTX_wm_window(C)->eventstate->alt != 0) {
+		index += 10;
+	}
+
+	Scene *scene = CTX_data_scene(C);
+	ViewLayer *view_layer = CTX_data_view_layer(C);
+	LayerCollection *lc = BKE_layer_collection_from_index(view_layer, index);
+
+	if (!lc) {
+		return OPERATOR_CANCELLED;
+	}
+
+	BKE_layer_collection_set_visible(scene, view_layer, lc, extend);
+
+	DEG_id_tag_update(&scene->id, DEG_TAG_BASE_FLAGS_UPDATE);
+	WM_event_add_notifier(C, NC_SCENE | ND_OB_SELECT, scene);
+
+	return OPERATOR_FINISHED;
+}
+
+#define COLLECTION_INVALID_INDEX -1
+
+void ED_hide_collections_menu_draw(const bContext *C, uiLayout *layout)
+{
+	ViewLayer *view_layer = CTX_data_view_layer(C);
+	LayerCollection *lc_scene = view_layer->layer_collections.first;
+
+	uiLayoutSetOperatorContext(layout, WM_OP_EXEC_REGION_WIN);
+
+	for (LayerCollection *lc = lc_scene->layer_collections.first; lc; lc = lc->next) {
+		int index = BKE_layer_collection_findindex(view_layer, lc);
+		uiLayout *row = uiLayoutRow(layout, false);
+
+		if (lc->collection->flag & COLLECTION_RESTRICT_VIEW) {
+			continue;
+		}
+
+		if ((view_layer->runtime_flag & VIEW_LAYER_HAS_HIDE) &&
+		    !(lc->runtime_flag & LAYER_COLLECTION_HAS_VISIBLE_OBJECTS)) {
+			uiLayoutSetActive(row, false);
+		}
+
+		int icon = ICON_NONE;
+		if (BKE_layer_collection_has_selected_objects(view_layer, lc)) {
+			icon = ICON_LAYER_ACTIVE;
+		}
+		else if (lc->runtime_flag & LAYER_COLLECTION_HAS_OBJECTS) {
+			icon = ICON_LAYER_USED;
+		}
+
+		uiItemIntO(row,
+		           lc->collection->id.name + 2,
+		           icon,
+		           "OBJECT_OT_hide_collection",
+		           "collection_index",
+		           index);
+	}
+}
+
+static int object_hide_collection_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
+{
+	/* Immediately execute if collection index was specified. */
+	int index = RNA_int_get(op->ptr, "collection_index");
+	if (index != COLLECTION_INVALID_INDEX) {
+		return object_hide_collection_exec(C, op);
+	}
+
+	/* Open popup menu. */
+	const char *title = CTX_IFACE_(op->type->translation_context, op->type->name);
+	uiPopupMenu *pup = UI_popup_menu_begin(C, title, ICON_GROUP);
+	uiLayout *layout = UI_popup_menu_layout(pup);
+
+	ED_hide_collections_menu_draw(C, layout);
+
+	UI_popup_menu_end(C, pup);
+
+	return OPERATOR_INTERFACE;
+}
+
+void OBJECT_OT_hide_collection(wmOperatorType *ot)
+{
+	/* identifiers */
+	ot->name = "Hide Objects By Collection";
+	ot->description = "Show only objects in collection (Shift to extend)";
+	ot->idname = "OBJECT_OT_hide_collection";
+
+	/* api callbacks */
+	ot->exec = object_hide_collection_exec;
+	ot->invoke = object_hide_collection_invoke;
+	ot->poll = ED_operator_view3d_active;
+
+	/* flags */
+	ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
+
+	/* Properties. */
+	PropertyRNA *prop;
+	prop = RNA_def_int(ot->srna, "collection_index", COLLECTION_INVALID_INDEX, COLLECTION_INVALID_INDEX, INT_MAX,
+	                   "Collection Index", "Index of the collection to change visibility", 0, INT_MAX);
+	RNA_def_property_flag(prop, PROP_SKIP_SAVE | PROP_HIDDEN);
 }
 
 /* ******************* toggle editmode operator  ***************** */
@@ -1661,8 +1770,6 @@ bool ED_object_editmode_calc_active_center(Object *obedit, const bool select_onl
 	return false;
 }
 
-#define COLLECTION_INVALID_INDEX -1
-
 static int move_to_collection_poll(bContext *C)
 {
 	if (CTX_wm_space_outliner(C) != NULL) {
@@ -1983,4 +2090,3 @@ void OBJECT_OT_link_to_collection(wmOperatorType *ot)
 	RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
-#undef COLLECTION_INVALID_INDEX
diff --git a/source/blender/editors/object/object_intern.h b/source/blender/editors/object/object_intern.h
index f64beeda15a..f7179912f52 100644
--- a/source/blender/editors/object/object_intern.h
+++ b/source/blender/editors/object/object_intern.h
@@ -78,6 +78,7 @@ void OBJECT_OT_unlink_data(struct wmOperatorType *ot);
 /* object_edit.c */
 void OBJECT_OT_hide_view_set(struct wmOperatorType *ot);
 void OBJECT_OT_hide_view_clear(struct wmOperatorType *ot);
+void OBJECT_OT_hide_collection(struct wmOperatorType *ot);
 void OBJECT_OT_mode_set(struct wmOperatorType *ot);
 void OBJECT_OT_mode_set_or_submode(struct wmOperatorType *ot);
 void OBJECT_OT_editmode_toggle(struct wmOperatorType *ot);
diff --git a/source/blender/editors/object/object_ops.c b/source/blender/editors/object/object_ops.c
index 59122fe3c23..ad14679622f 100644
--- a/source/blender/editors/object/object_ops.c
+++ b/source/blender/editors/object/object_ops.c
@@ -250,6 +250,7 @@ void ED_operatortypes_object(void)
 
 	WM_operatortype_append(OBJECT_OT_hide_view_clear);
 	WM_operatortype_append(OBJECT_OT_hide_view_set);
+	WM_operatortype_append(OBJECT_OT_hide_collection);
 }
 
 void ED_operatormacros_object(void)
@@ -409,11 +410,17 @@ void ED_keymap_object(wmKeyConfig *keyconf)
 	WM_keymap_add_item(keymap, "OBJECT_OT_link_to_collection", MKEY, KM_PRESS, KM_SHIFT, 0);
 
 	kmi = WM_keymap_add_item(keymap, "OBJECT_OT_hide_view_clear", HKEY, KM_PRESS, KM_ALT, 0);
-	RNA_boolean_set(kmi->ptr, "select", false);
 	kmi = WM_keymap_add_item(keymap, "OBJECT_OT_hide_view_set", HKEY, KM_PRESS, 0, 0);
 	RNA_boolean_set(kmi->ptr, "unselected", false);
 	kmi = WM_keymap_add_item(keymap, "OBJECT_OT_hide_view_set", HKEY, KM_PRESS, KM_SHIFT, 0);
 	RNA_boolean_set(kmi->ptr, "unselected", true);
+	kmi = WM_keymap_add_item(keymap, "OBJECT_OT_hide_collection", HKEY, KM_PRESS, KM_CTRL, 0);
+
+	/* Collection switching. */
+	for (int i = 0; i < 10; i++) {
+		kmi = WM_keymap_add_item(keymap, "OBJECT_OT_hide_collection", ZEROKEY + i, KM_PRESS, KM_ANY, 0);
+		RNA_int_set(kmi->ptr, "collection_index", (i == 0) ? 10 : i);
+	}
 }
 
 void ED_keymap_proportional_cycle(struct wmKeyConfig *UNUSED(keyconf), struct wmKeyMap *keymap)