Collections and groups unification

OVERVIEW

* In 2.7 terminology, all layers and groups are now collection datablocks.
* These collections are nestable, linkable, instanceable, overrideable, ..
  which opens up new ways to set up scenes and link + override data.
* Viewport/render visibility and selectability are now a part of the collection
  and shared across all view layers and linkable.
* View layers define which subset of the scene collection hierarchy is excluded
  for each. For many workflows one view layer can be used, these are more of an
  advanced feature now.

OUTLINER

* The outliner now has a "View Layer" display mode instead of "Collections",
  which can display the collections and/or objects in the view layer.
* In this display mode, collections can be excluded with the right click menu.
  These will then be greyed out and their objects will be excluded.
* To view collections not linked to any scene, the "Blender File" display mode
  can be used, with the new filtering option to just see Colleciton datablocks.
* The outliner right click menus for collections and objects were reorganized.
* Drag and drop still needs to be improved. Like before, dragging the icon or
  text gives different results, we'll unify this later.

LINKING AND OVERRIDES

* Collections can now be linked into the scene without creating an instance,
  with the link/append operator or from the collections view in the outliner.
* Collections can get static overrides with the right click menu in the outliner,
  but this is rather unreliable and not clearly communicated at the moment.
* We still need to improve the make override operator to turn collection instances
  into collections with overrides directly in the scene.

PERFORMANCE

* We tried to make performance not worse than before and improve it in some
  cases. The main thing that's still a bit slower is multiple scenes, we have to
  change the layer syncing to only updated affected scenes.
* Collections keep a list of their parent collections for faster incremental
  updates in syncing and caching.
* View layer bases are now in a object -> base hash to avoid quadratic time
  lookups internally and in API functions like visible_get().

VERSIONING

* Compatibility with 2.7 files should be improved due to the new visibility
  controls. Of course users may not want to set up their scenes differently
  now to avoid having separate layers and groups.
* Compatibility with 2.8 is mostly there, and was tested on Eevee demo and Hero
  files. There's a few things which are know to be not quite compatible, like
  nested layer collections inside groups.
* The versioning code for 2.8 files is quite complicated, and isolated behind
  #ifdef so it can be removed at the end of the release cycle.

KNOWN ISSUES

* The G-key group operators in the 3D viewport were left mostly as is, they
  need to be modified still to fit better.
* Same for the groups panel in the object properties. This needs to be updated
  still, or perhaps replaced by something better.
* Collections must all have a unique name. Less restrictive namespacing is to
  be done later, we'll have to see how important this is as all objects within
  the collections must also have a unique name anyway.
* Full scene copy and delete scene are exactly doing the right thing yet.

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

https://code.blender.org/2018/05/collections-and-groups/

1 files changed, 16 insertions, 38 deletions

diff --git a/source/blender/blenkernel/BKE_layer.h b/source/blender/blenkernel/BKE_layer.h
index 00154f3e68e..25130f43b73 100644
--- a/source/blender/blenkernel/BKE_layer.h
+++ b/source/blender/blenkernel/BKE_layer.h
@@ -29,6 +29,7 @@
 
 #include "BKE_collection.h"
 
+#include "DNA_listBase.h"
 #include "DNA_scene_types.h"
 
 #ifdef __cplusplus
@@ -42,8 +43,8 @@ extern "C" {
 #define ROOT_PROP "root"
 
 struct Base;
+struct Collection;
 struct Depsgraph;
-struct Group;
 struct ID;
 struct IDProperty;
 struct LayerCollection;
@@ -52,7 +53,6 @@ struct Main;
 struct Object;
 struct RenderEngine;
 struct Scene;
-struct SceneCollection;
 struct ViewLayer;
 struct WorkSpace;
 
@@ -60,7 +60,6 @@ struct ViewLayer *BKE_view_layer_default_view(const struct Scene *scene);
 struct ViewLayer *BKE_view_layer_default_render(const struct Scene *scene);
 struct ViewLayer *BKE_view_layer_from_workspace_get(const struct Scene *scene, const struct WorkSpace *workspace);
 struct ViewLayer *BKE_view_layer_add(struct Scene *scene, const char *name);
-struct ViewLayer *BKE_view_layer_group_add(struct Group *group);
 
 /* DEPRECATED */
 struct ViewLayer *BKE_view_layer_context_active_PLACEHOLDER(const struct Scene *scene);
@@ -71,57 +70,36 @@ void BKE_view_layer_free_ex(struct ViewLayer *view_layer, const bool do_id_user)
 void BKE_view_layer_selected_objects_tag(struct ViewLayer *view_layer, const int tag);
 
 struct Object *BKE_view_layer_camera_find(struct ViewLayer *view_layer);
-struct ViewLayer *BKE_view_layer_first_from_id(const struct ID *owner_id);
-struct ViewLayer *BKE_view_layer_find_from_collection(const struct ID *owner_id, struct LayerCollection *lc);
+struct ViewLayer *BKE_view_layer_find_from_collection(const struct Scene *scene, struct LayerCollection *lc);
 struct Base *BKE_view_layer_base_find(struct ViewLayer *view_layer, struct Object *ob);
 void BKE_view_layer_base_deselect_all(struct ViewLayer *view_layer);
 void BKE_view_layer_base_select(struct ViewLayer *view_layer, struct Base *selbase);
 
-void BKE_layer_collection_sync_flags(
-        struct ID *owner_id,
-        struct SceneCollection *scene_collection_dst,
-        struct SceneCollection *scene_collection_src);
-
 void BKE_view_layer_copy_data(
-        struct ViewLayer *view_layer_dst, struct ViewLayer *view_layer_src,
-        struct SceneCollection *mc_dst, struct SceneCollection *mc_src,
+        struct Scene *scene_dst, const struct Scene *scene_src,
+        struct ViewLayer *view_layer_dst, const struct ViewLayer *view_layer_src,
         const int flag);
 
-struct LayerCollection *BKE_layer_collection_duplicate(struct ID *owner_id, struct LayerCollection *layer_collection);
-
-void BKE_layer_collection_free(struct ViewLayer *view_layer, struct LayerCollection *lc);
-
 struct LayerCollection *BKE_layer_collection_get_active(struct ViewLayer *view_layer);
-struct LayerCollection *BKE_layer_collection_get_active_ensure(struct Scene *scene, struct ViewLayer *view_layer);
+bool BKE_layer_collection_activate(struct ViewLayer *view_layer, struct LayerCollection *lc);
+struct LayerCollection *BKE_layer_collection_activate_parent(struct ViewLayer *view_layer, struct LayerCollection *lc);
 
 int BKE_layer_collection_count(struct ViewLayer *view_layer);
 
 struct LayerCollection *BKE_layer_collection_from_index(struct ViewLayer *view_layer, const int index);
 int BKE_layer_collection_findindex(struct ViewLayer *view_layer, const struct LayerCollection *lc);
 
-bool BKE_layer_collection_move_above(const struct ID *owner_id, struct LayerCollection *lc_dst, struct LayerCollection *lc_src);
-bool BKE_layer_collection_move_below(const struct ID *owner_id, struct LayerCollection *lc_dst, struct LayerCollection *lc_src);
-bool BKE_layer_collection_move_into(const struct ID *owner_id, struct LayerCollection *lc_dst, struct LayerCollection *lc_src);
-
-void BKE_layer_collection_resync(const struct ID *owner_id, const struct SceneCollection *sc);
+void BKE_main_collection_sync(const struct Main *bmain);
+void BKE_scene_collection_sync(const struct Scene *scene);
+void BKE_layer_collection_sync(const struct Scene *scene, struct ViewLayer *view_layer);
 
-struct LayerCollection *BKE_collection_link(struct ViewLayer *view_layer, struct SceneCollection *sc);
+void BKE_main_collection_sync_remap(const struct Main *bmain);
 
-void BKE_collection_unlink(struct ViewLayer *view_layer, struct LayerCollection *lc);
-
-void BKE_collection_enable(struct ViewLayer *view_layer, struct LayerCollection *lc);
-
-struct LayerCollection *BKE_layer_collection_first_from_scene_collection(struct ViewLayer *view_layer, const struct SceneCollection *scene_collection);
-bool BKE_view_layer_has_collection(struct ViewLayer *view_layer, const struct SceneCollection *sc);
+struct LayerCollection *BKE_layer_collection_first_from_scene_collection(struct ViewLayer *view_layer, const struct Collection *collection);
+bool BKE_view_layer_has_collection(struct ViewLayer *view_layer, const struct Collection *collection);
 bool BKE_scene_has_object(struct Scene *scene, struct Object *ob);
 
-void BKE_layer_collection_objects_select(struct LayerCollection *layer_collection);
-
-/* syncing */
-
-void BKE_layer_sync_new_scene_collection(struct ID *owner_id, const struct SceneCollection *sc_parent, struct SceneCollection *sc);
-void BKE_layer_sync_object_link(const struct ID *owner_id, struct SceneCollection *sc, struct Object *ob);
-void BKE_layer_sync_object_unlink(const struct ID *owner_id, struct SceneCollection *sc, struct Object *ob);
+bool BKE_layer_collection_objects_select(struct ViewLayer *view_layer, struct LayerCollection *lc, bool deselect);
 
 /* override */
 
@@ -134,12 +112,12 @@ void BKE_override_layer_collection_boolean_add(struct LayerCollection *layer_col
 
 void BKE_layer_eval_view_layer(
         struct Depsgraph *depsgraph,
-        struct ID *owner_id,
+        struct Scene *scene,
         struct ViewLayer *view_layer);
 
 void BKE_layer_eval_view_layer_indexed(
         struct Depsgraph *depsgraph,
-        struct ID *owner_id,
+        struct Scene *scene,
         int view_layer_index);
 
 /* iterators */