Merge pull request #142 from brunomikoski/feature/ui-toolkit

Feature/UI toolkit

Author: brunomikoski

CHANGELOG.MD

@@ -6,12 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.3.0]
+### Changed
+- Refactored CollectionCustomEditor to use UI Elements, getting rid of multiple hacks to make it work with the IMGUI and Reorderable list
+- Updated the visuals of the Collection Editor
+- Advanced Options are now exposed by default, giving more clarify of what is going on
+- Removed the editor only assets from the Collection (`generateAsPartialClass`, `generateAsBaseClass`, `generateAsStaticClass`), those are not stored on the SOCSettings file and versioned
+- The `guid`, `items` and `automaticallyLoaded` are now `HideInInspector` on the Collection, to avoid confusion
+- Added new USS and UXML files to the Collection Editor
+- Generated static files now contains the default `.g.cs` postfix 
+- If you set your Default Folder for Generated Files to null on the settings, it will now use the same folder as the original collection .cs files.
+- If you now set your namespace to empty on the settings, it will now use the same namespace as the original collection .cs files.
+- Add new Context Menu on the Collection to generate the indirect file for the collection
+- Fixed GoTo button not working on the PropertyDrawer, now will probably select the collection and expand only the item you want.
+
+### Added
+- Added new Default Inspector session to the Collection Editor, where you can see the default inspector of the collection and expose more items there.
+- Collections now can be enforced to use Indirect Reference, this will show an error message if the collection is not using Indirect Reference
+
+### Know issues
+- Settings will not be automatically converted to the new SOCSettings file, settings like _(custom namespace, filename, or target folder)_ so you have to reconfigure those settings manually
+
 ## [2.2.4]
 ### Added
-* Added Item Order Protection. Override the `ShouldProtectItemOrder` property in your Collection to disallow items being dragged or deleted.
+- Added Item Order Protection. Override the `ShouldProtectItemOrder` property in your Collection to disallow items being dragged or deleted.
 
 ### Fixed
-* Fixed SOC Item property drawers not working in certain Unity versions by @RoyTheunissen in https://github.com/brunomikoski/ScriptableObjectCollection/pull/141
+- Fixed SOC Item property drawers not working in certain Unity versions by @RoyTheunissen in https://github.com/brunomikoski/ScriptableObjectCollection/pull/141
 
 ## [2.2.3]
 ### Fixed
@@ -520,6 +541,7 @@ public bool IsValidConsumable(Consumable consumable)
 ### Added 
  - First initial working version 
 
+[2.3.0]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.3.0
 [2.2.4]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.2.4
 [2.2.3]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.2.3
 [2.2.2]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.2.2

Editor.meta

@@ -0,0 +1,25 @@
+#header-foldout .unity-label {
+    -unity-font-style: bold;
+    flex-grow: 1;
+}
+
+#header-foldout #unity-content {
+    margin-bottom: 10px;
+}
+
+#ContentGroup ScrollView {
+    border-top-left-radius: 0;
+    border-top-right-radius: 0;
+}
+
+#rename-text-field #unity-text-input {
+    border-left-color: rgba(0, 0, 0, 0);
+    border-right-color: rgba(0, 0, 0, 0);
+    border-top-color: rgba(0, 0, 0, 0);
+    border-bottom-color: rgba(0, 0, 0, 0);
+    border-top-width: 0;
+    border-right-width: 0;
+    border-bottom-width: 0;
+    border-left-width: 0;
+    background-color: rgba(255, 255, 255, 0);
+}

Editor/USS.meta

@@ -0,0 +1,52 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
+    <Style src="project://database/Packages/com.brunomikoski.scriptableobjectcollection/Editor/USS/CollectionStyle.uss?fileID=7433441132597879392&amp;guid=f6040fd5efe6a1e43a9e95760a53fcba&amp;type=3#CollectionStyle" />
+    <ui:VisualElement name="HeaderGroup" style="flex-grow: 0; padding-bottom: 10px; padding-top: 4px;" />
+    <ui:VisualElement name="ContentGroup" style="flex-grow: 1; margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0;">
+        <ui:VisualElement name="VisualElement" style="flex-grow: 1; margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0; border-top-width: 1px; border-right-width: 1px; border-bottom-width: 0; border-left-width: 1px; border-left-color: rgb(32, 32, 32); border-right-color: rgb(32, 32, 32); border-top-color: rgb(32, 32, 32); border-bottom-color: rgb(32, 32, 32); padding-top: 2px; padding-right: 2px; padding-bottom: 0; padding-left: 4px; font-size: 12px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom-right-radius: 0; border-bottom-left-radius: 0; background-color: rgb(48, 48, 48); flex-direction: row;">
+            <ui:Label tabindex="-1" text="Items" parse-escape-sequences="true" display-tooltip-when-elided="true" style="-unity-font-style: bold; font-size: 12px;" />
+            <ui:VisualElement style="flex-grow: 1; flex-direction: row; justify-content: flex-end;">
+                <ui:Button parse-escape-sequences="true" display-tooltip-when-elided="true" name="expand-button" tooltip="Expand / Collapse Items" text="↓ " enable-rich-text="false" style="width: 18px; height: 18px;" />
+                <ui:Button parse-escape-sequences="true" display-tooltip-when-elided="true" name="sort-button" style="width: 18px; height: 18px; display: none;" />
+            </ui:VisualElement>
+        </ui:VisualElement>
+        <uie:ToolbarSearchField name="ToolbarSearchField" style="width: auto; margin-left: 0; margin-right: 0; margin-top: 0; margin-bottom: 0; padding-bottom: 0; top: 4px; left: 200px; right: 30px; position: absolute;" />
+        <ui:ListView virtualization-method="DynamicHeight" show-border="true" show-alternating-row-backgrounds="All" reorderable="true" show-foldout-header="false" header-title="Items" show-add-remove-footer="false" reorder-mode="Animated" show-bound-collection-size="false" name="items-list-view" horizontal-scrolling="false" selection-type="Single" view-data-key="collection-item-list-view" style="display: flex;" />
+        <ui:VisualElement name="unity-list-view__footer" class="unity-list-view__footer">
+            <ui:Button name="unity-list-view__remove-button" text="-" class="unity-text-element unity-button" />
+            <ui:Button name="unity-list-view__add-button" text="+" class="unity-text-element unity-button" />
+        </ui:VisualElement>
+    </ui:VisualElement>
+    <ui:VisualElement name="BottonGroup">
+        <ui:VisualElement style="flex-grow: 1; flex-direction: column;">
+            <ui:Button text="Generate Static File" parse-escape-sequences="true" display-tooltip-when-elided="true" tooltip="Uses Code Generation to generate the Static File to access collection items by code." name="generate-static-file-button" style="flex-grow: 1;" />
+            <ui:Button text="Synchronize Assets" parse-escape-sequences="true" display-tooltip-when-elided="true" tooltip="Check for invalid references and reload found items into the collection" name="synchronize-items-button" style="flex-grow: 1;" />
+        </ui:VisualElement>
+        <ui:VisualElement style="flex-grow: 1; flex-direction: row; margin-top: 20px;">
+            <ui:Button text="Generate Items" parse-escape-sequences="true" display-tooltip-when-elided="true" tooltip="Uses Code Generation to generate the Static File to access collection items by code." name="generate-auto-items" style="flex-grow: 1; min-height: 60px;" />
+        </ui:VisualElement>
+        <ui:VisualElement name="DefaultGroupBox">
+            <ui:VisualElement name="VisualElement" style="flex-grow: 1; margin-top: 20px;">
+                <ui:VisualElement name="advanced-header-visual-element" style="flex-grow: 1; margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0; border-top-width: 1px; border-right-width: 1px; border-bottom-width: 1px; border-left-width: 1px; border-left-color: rgb(32, 32, 32); border-right-color: rgb(32, 32, 32); border-top-color: rgb(32, 32, 32); border-bottom-color: rgb(32, 32, 32); padding-top: 2px; padding-right: 2px; padding-bottom: 2px; padding-left: 4px; font-size: 12px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom-right-radius: 0; border-bottom-left-radius: 0; background-color: rgb(48, 48, 48);">
+                    <ui:Label tabindex="-1" text="Advanced" parse-escape-sequences="true" display-tooltip-when-elided="true" name="Label" style="-unity-font-style: bold; font-size: 12px;" />
+                </ui:VisualElement>
+                <ui:VisualElement style="flex-grow: 1; border-left-color: rgb(32, 32, 32); border-right-color: rgb(32, 32, 32); border-top-color: rgb(32, 32, 32); border-bottom-color: rgb(32, 32, 32); border-top-width: 0; border-right-width: 1px; border-bottom-width: 1px; border-left-width: 1px; border-top-left-radius: 0; border-top-right-radius: 0; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px; margin-top: 0; padding-top: 10px; padding-right: 10px; padding-left: 10px; padding-bottom: 10px; flex-wrap: nowrap; align-items: stretch;">
+                    <ui:Toggle label="Automaticaly Loaded" name="automatic-loaded-toggle" binding-path="automaticallyLoaded" class="unity-base-field__aligned" style="flex-grow: 0; -unity-font-style: normal;" />
+                    <ui:Toggle label="Write as Partial Class" name="write-partial-class-toggle" class="unity-base-field__aligned" />
+                    <ui:Toggle label="Use Base Class for Items" name="base-class-for-items-toggle" class="unity-base-field__aligned" />
+                    <ui:Toggle label="Enforce Indirect Access" name="enforce-indirect-access" tooltip="Useful if this collections is not auto loaded, or loaded through addressables, or you just want to have better memory management" class="unity-base-field__aligned" />
+                    <uie:ObjectField label="Generated Scripts Folde" type="UnityEditor.DefaultAsset, UnityEditor.CoreModule" allow-scene-objects="false" name="generated-scripts-parent-folder" class="unity-base-field__aligned" />
+                    <ui:TextField picking-mode="Ignore" label="Static Filename" value="filler text" name="static-filename-textfield" is-delayed="true" class="unity-base-field__aligned" />
+                    <ui:TextField picking-mode="Ignore" label="Namespace" value="filler text" name="namespace-textfield" is-delayed="true" class="unity-base-field__aligned" />
+                </ui:VisualElement>
+            </ui:VisualElement>
+        </ui:VisualElement>
+        <ui:VisualElement name="extra-properties-visual-element" style="flex-grow: 1; margin-top: 20px;">
+            <ui:VisualElement name="advanced-header-visual-element" style="flex-grow: 1; margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0; border-top-width: 1px; border-right-width: 1px; border-bottom-width: 1px; border-left-width: 1px; border-left-color: rgb(32, 32, 32); border-right-color: rgb(32, 32, 32); border-top-color: rgb(32, 32, 32); border-bottom-color: rgb(32, 32, 32); padding-top: 2px; padding-right: 2px; padding-bottom: 2px; padding-left: 4px; font-size: 12px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom-right-radius: 0; border-bottom-left-radius: 0; background-color: rgb(48, 48, 48);">
+                <ui:Label tabindex="-1" text="Default Inspector" parse-escape-sequences="true" display-tooltip-when-elided="true" name="Label" style="-unity-font-style: bold; font-size: 12px;" />
+            </ui:VisualElement>
+            <ui:VisualElement style="flex-grow: 1; border-left-color: rgb(32, 32, 32); border-right-color: rgb(32, 32, 32); border-top-color: rgb(32, 32, 32); border-bottom-color: rgb(32, 32, 32); border-top-width: 0; border-right-width: 1px; border-bottom-width: 1px; border-left-width: 1px; border-top-left-radius: 0; border-top-right-radius: 0; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px; margin-top: 0; padding-top: 10px; padding-right: 10px; padding-left: 10px; padding-bottom: 10px; flex-wrap: nowrap; align-items: stretch;">
+                <ui:IMGUIContainer />
+            </ui:VisualElement>
+        </ui:VisualElement>
+    </ui:VisualElement>
+</ui:UXML>

Editor/USS/CollectionStyle.uss

@@ -0,0 +1,9 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
+    <Style src="project://database/Packages/com.brunomikoski.scriptableobjectcollection/Editor/USS/CollectionStyle.uss?fileID=7433441132597879392&amp;guid=f6040fd5efe6a1e43a9e95760a53fcba&amp;type=3#CollectionStyle" />
+    <ui:VisualElement name="VisualElement" style="flex-grow: 1; padding-top: 0; padding-right: 0; padding-bottom: 0; padding-left: 0; margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0;">
+        <ui:Foldout name="header-foldout" text="Title" value="true">
+            <ui:IMGUIContainer name="imgui-container" style="margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0; padding-bottom: 0;" />
+        </ui:Foldout>
+        <ui:TextField picking-mode="Ignore" value="Default Endless" name="rename-text-field" is-delayed="true" style="display: none; position: absolute; flex-grow: 1; top: 0; width: 100%; background-color: rgba(0, 0, 0, 0); -unity-font-style: bold; margin-left: 0; left: 2px; overflow: visible; visibility: visible;" />
+    </ui:VisualElement>
+</ui:UXML>