Merge pull request #193 from brunomikoski/feature/new-bitewise-for-picker

Bitwise for Item Picker and Query

Author: brunomikoski

CHANGELOG.MD

@@ -4,16 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [2.6.0] - 05/16/2026
 ### Added
+- New `PreviewMode` enum (`Default`/`Inline`/`PropertyEditorWindow`) on `SOCItemEditorOptionsAttribute`, plus a matching project-wide default in `SOCSettings` (Project Settings > Scriptable Object Collection > Item Inspector). When set to `PropertyEditorWindow`, the per-field Edit button opens Unity's floating Property Editor via `EditorUtility.OpenPropertyEditor` instead of the inline preview panel — fixes rendering issues with third-party inspectors (e.g. Odin) that don't draw correctly in the inline IMGUI drawer. `Default` on the attribute defers to the project setting; project setting defaults to `Inline` so existing behavior is unchanged.
+- New `CollectionItemMask64` static helper plus `IEnumerable<T>.ToItemMask64<T>()` and `List<T>.FromItemMask64<T>()` extension methods. Provides a 64-bit bitmask representation of a set of collection items keyed on `ScriptableObjectCollectionItem.Index`, with `Bit`/`Has`/`Add`/`Remove`/`Overlaps`/`IsSubsetOf` helpers and a `From<T>(items, out bool fits)` builder that flags when any item's `Index >= 64`. Bit positions are per-collection — callers are responsible for only comparing masks built from items of the same collection.
+- `CollectionItemPicker<T>` now exposes a cached bitmask (`CachedMask`) and a `CanUseBitmask` gate (combines `MaskFitsIn64` with every item collection's `SupportsBitmaskIndexing` flag), plus `CountMatchesIn(ulong)` and `CountMatchesIn(IEnumerable<T>)` overloads backed by a SWAR `PopCount`. The mask is rebuilt on `OnAfterDeserialize`, on every mutating operation (`Add`/`Clear`/`Remove`/`Insert`/`RemoveAt`/indexer set), and lazily in Edit Mode; reused without rebuild in Play Mode.
+- `ScriptableObjectCollection` virtual `SupportsBitmaskIndexing` (default `true`). Override to `false` on collections whose item ordering can change at runtime (e.g. CDN-delivered content) so the bitmask fast path is skipped — each item's `Index` is cached on first access and would otherwise go stale after a reorder.
 - `CollectionItemPicker<T>.ToString()` override returning `[item1, item2, ...]` (empty collection renders as `[]`; null entries render as `<null>`). Uses `StringBuilder` to avoid per-call allocations on long pickers.
 - `CollectionItemQuery<T>.IsEmpty()` returns `true` when every `QuerySet`'s picker contains zero items — useful for skipping the `Matches` evaluation on default-constructed queries.
 - `CollectionItemPickerPropertyDrawer` now writes `itemLastKnownName` and `collectionLastKnownName` when an entry is added to a picker, so newly added items have populated cache names immediately instead of empty strings.
 
 ### Changed
 - Reverted `CollectionItemQuery.MatchType` enum values: `SomeNot` → `NotAny`, `None` → `NotAll`. The new names mirror `Any`/`All` and describe the actual semantics (target has *none* of the picker items / target is missing *at least one* of them). Integer values are preserved (2 and 3), so existing serialized `QuerySet` data deserializes unchanged.
 - Added XML documentation on `MatchType` values and the `Matches` method to surface the semantics in IntelliSense.
-- `CollectionItemPicker<T>` events renamed: `OnItemTypeAddedEvent` → `OnItemAddedEvent`, `OnItemTypeRemovedEvent` → `OnItemRemovedEvent`. **Breaking** for external subscribers — `+=`/`-=` call sites must be updated. `OnChangedEvent` is unchanged.
+- `CollectionItemQuery<T>.Matches` now selects between a bitmask fast path (`MatchesViaBitmask`) and the existing GUID-based path (`MatchesViaGuids`) at the start of each call. The bitmask path is used only when every `QuerySet`'s picker reports `CanUseBitmask == true`; otherwise the call falls back to the original GUID comparison. Match results are unchanged — only the evaluation strategy.
+- `CollectionItemPicker<T>` events renamed: `OnItemTypeAddedEvent` → `OnItemAddedEvent`, `OnItemTypeRemovedEvent` → `OnItemRemovedEvent`. The old names are preserved as `[Obsolete]` shims with explicit `add`/`remove` accessors that forward subscriptions to the new events, so existing `+=`/`-=` call sites keep compiling with a deprecation warning pointing to the new name. The shims will be removed in a future major version. `OnChangedEvent` is unchanged.
 - `CollectionItemIndirectReference.itemLastKnownName` and `collectionLastKnownName` are now wrapped in `#if UNITY_EDITOR` and no longer compiled into player builds. Runtime resolution relies exclusively on GUIDs.
 - `CollectionItemQuery<T>.Matches(IEnumerable<T> targetItems, out int)` now tolerates a `null` `targetItems` — treated as empty, so `Any`/`All` sets fail and `NotAny`/`NotAll` sets pass.
 
@@ -24,6 +29,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 - Removed the runtime fallback in `CollectionItemIndirectReference.TryGetCollectionItem` that, when the stored GUIDs failed to resolve, attempted to look the collection and item back up by `collectionLastKnownName`/`itemLastKnownName`. With the names now editor-only, GUID is the single runtime lookup path; rename recovery is handled at edit time by the drawer instead.
+- Removed long-deprecated `[Obsolete]` API surface that has been carrying compile warnings across prior releases:
+  - `SOCSettings.SetDefaultNamespace(string)` — use `SetNamespacePrefix(string)` instead.
+  - The four `ScriptableObjectCollectionUtility.CreateScriptableObjectOfType(...)` overloads that took a `parentFolder` / `parentFolderPath` plus a `createFolderForThisCollection` bool. Use the overloads that take a complete path; build the path with `Path.Combine` at the call site if you previously relied on the auto-folder behavior.
+  - `DrawAsSOCItemAttribute` — no longer needed since Unity 2022.2 supports `PropertyDrawer` on interfaces directly.
+  - `CollectionItemEditorOptions` class — use `SOCItemEditorOptionsAttribute` instead.
+  - `CollectionsRegistry.GetCollectionByGUID(string)` — use the `LongGuid` overload (regenerate your collection's static access class to pick up the new GUID type).
+  - `ScriptableObjectCollection.GetItemByGUID(string)` — use the `LongGuid` overload (same: regenerate the static access class).
 
 ## [2.5.1] - 06/04/2026
 ### Added

Scripts/Editor/Core/CodeGenerationUtility.cs

@@ -366,11 +366,7 @@ public static void GenerateIndirectAccessForCollectionItemType(string collection
 
             // Delete any existing files that have the old deprecated extension.
             string deprecatedFileName = targetFileName + ExtensionOld;
-#if UNITY_2023_1_OR_NEWER
             if (AssetDatabase.AssetPathExists(deprecatedFileName))
-#else
-            if (AssetDatabase.LoadAssetAtPath<UnityEngine.Object>(deprecatedFileName) != null)
-#endif
             {
                 Debug.LogWarning($"Deleting deprecated Indirect Access file '{deprecatedFileName}'.");
                 AssetDatabase.DeleteAsset(deprecatedFileName);

Scripts/Editor/Core/SOCSettings.cs

@@ -67,6 +67,11 @@ public static SOCSettings Instance
         [SerializeField]
         internal string generatedScriptsDefaultFilePath = @"Assets\Generated\Scripts";
 
+        [SerializeField]
+        private PreviewMode defaultPreviewMode = PreviewMode.Inline;
+        public PreviewMode DefaultPreviewMode =>
+            defaultPreviewMode == PreviewMode.Default ? PreviewMode.Inline : defaultPreviewMode;
+
         private static readonly GUIContent namespacePrefixGUIContent = new GUIContent(
             "Prefix",
             "When using the Create New Collection wizard," +
@@ -77,14 +82,6 @@ public static SOCSettings Instance
             "If specified, automatically derived namespaces will only include up to this many folders inside your " +
             "project's Scripts folder.");
 
-        
-        [Obsolete("Default Namespace has been renamed to Namespace Prefix. Please use the corresponding function.")]
-        public void SetDefaultNamespace(string namespacePrefix)
-        {
-            SetNamespacePrefix(namespacePrefix);
-            Save();
-        }
-        
         public void SetNamespacePrefix(string namespacePrefix)
         {
             this.namespacePrefix = namespacePrefix;
@@ -130,6 +127,28 @@ public void OnSceneGUI(string search)
                 }
             }
 
+            EditorGUILayout.LabelField("Item Inspector", EditorStyles.boldLabel);
+            using (EditorGUI.ChangeCheckScope changeCheck = new EditorGUI.ChangeCheckScope())
+            {
+                PreviewMode resolvedMode = DefaultPreviewMode;
+                PreviewMode newMode = (PreviewMode)EditorGUILayout.EnumPopup(
+                    new GUIContent(
+                        "Default Preview Mode",
+                        "How the Edit button on a collection item field reveals the item.\n" +
+                        "Inline draws the item's properties beneath the field.\n" +
+                        "Property Editor Window opens Unity's floating inspector — useful when " +
+                        "third-party inspectors (e.g. Odin) don't render correctly inline.\n" +
+                        "Per-field [SOCItemEditorOptions(PreviewMode = ...)] overrides this."),
+                    resolvedMode,
+                    value => (PreviewMode)value != PreviewMode.Default,
+                    false);
+                if (changeCheck.changed)
+                {
+                    defaultPreviewMode = newMode;
+                    Save();
+                }
+            }
+
             EditorGUILayout.LabelField("Default Generated Scripts Folder", EditorStyles.boldLabel);
             using (EditorGUI.ChangeCheckScope changeCheck = new EditorGUI.ChangeCheckScope())
             {
@@ -157,6 +176,12 @@ public void SetGeneratedScriptsDefaultFilePath(string assetPath)
             Save();
         }
 
+        public void SetDefaultPreviewMode(PreviewMode previewMode)
+        {
+            defaultPreviewMode = previewMode == PreviewMode.Default ? PreviewMode.Inline : previewMode;
+            Save();
+        }
+
         public void Save()
         {
             string json = EditorJsonUtility.ToJson(this);

Scripts/Editor/PropertyDrawers/CollectionItemPropertyDrawer.cs

@@ -9,9 +9,7 @@
 
 namespace BrunoMikoski.ScriptableObjectCollections
 {
-#if UNITY_2022_2_OR_NEWER
     [CustomPropertyDrawer(typeof(ISOCItem), true)]
-#endif
     [CustomPropertyDrawer(typeof(ScriptableObjectCollectionItem), true)]
     public class CollectionItemPropertyDrawer : PropertyDrawer
     {
@@ -331,17 +329,29 @@ private void DrawEditFoldoutButton(ref Rect popupRect, ScriptableObject targetIt
             popupRect.width -= buttonRect.width;
             buttonRect.x += popupRect.width;
 
-            GUIContent guiContent = CollectionEditorGUI.EditGUIContent;
+            if (ResolvePreviewMode() == PreviewMode.PropertyEditorWindow)
+            {
+                if (GUI.Button(buttonRect, CollectionEditorGUI.EditGUIContent))
+                    EditorUtility.OpenPropertyEditor(targetItem);
+                return;
+            }
 
-            if (showingItemPreview)
-                guiContent = CollectionEditorGUI.CloseGUIContent;
+            GUIContent guiContent = showingItemPreview
+                ? CollectionEditorGUI.CloseGUIContent
+                : CollectionEditorGUI.EditGUIContent;
 
             if (GUI.Button(buttonRect, guiContent))
             {
                 showingItemPreview = !showingItemPreview;
             }
         }
 
+        private PreviewMode ResolvePreviewMode()
+        {
+            PreviewMode mode = OptionsAttribute.PreviewMode;
+            return mode == PreviewMode.Default ? SOCSettings.Instance.DefaultPreviewMode : mode;
+        }
+
         public void OverrideFieldInfo(FieldInfo targetFieldInfo)
         {
             overrideFieldInfo = targetFieldInfo;

Scripts/Editor/Utils/ScriptableObjectCollectionUtility.cs

@@ -19,24 +19,6 @@ public static T CreateScriptableObjectOfType<T>(string path, string name) where
             return CreateScriptableObjectOfType(typeof(T), path, name) as T;
         }
 
-        [Obsolete("Please use the overload that contains a complete path.")]
-        public static T CreateScriptableObjectOfType<T>(DefaultAsset parentFolder, bool createFolderForThisCollection,
-            string targetName) where T : ScriptableObject
-        {
-            return CreateScriptableObjectOfType<T>(AssetDatabase.GetAssetPath(parentFolder),
-                createFolderForThisCollection, targetName);
-        }
-
-        [Obsolete("Please use the overload that contains a complete path.")]
-        public static T CreateScriptableObjectOfType<T>(string parentFolderPath, bool createFolderForThisCollection,
-            string targetName) where T : ScriptableObject
-        {
-            if (createFolderForThisCollection)
-                parentFolderPath = Path.Combine(parentFolderPath, $"{targetName}");
-            
-            return CreateScriptableObjectOfType<T>(parentFolderPath, targetName);
-        }
-        
         public static ScriptableObject CreateScriptableObjectOfType(Type targetType, string path, string name)
         {
             ScriptableObject targetCollection = ScriptableObject.CreateInstance(targetType);
@@ -49,25 +31,6 @@ public static ScriptableObject CreateScriptableObjectOfType(Type targetType, str
             return targetCollection;
         }
 
-        [Obsolete("Please use the overload that contains a complete path.")]
-        public static ScriptableObject CreateScriptableObjectOfType(Type targetType, string parentFolderPath,
-            bool createFolderForThisCollection, string targetName)
-        {
-            if (createFolderForThisCollection)
-                parentFolderPath = Path.Combine(parentFolderPath, $"{targetName}");
-            
-            return CreateScriptableObjectOfType(targetType, parentFolderPath, targetName);
-        }
-
-        [Obsolete("Please use the overload that contains a complete path.")]
-        public static ScriptableObject CreateScriptableObjectOfType(
-            Type targetType, DefaultAsset parentFolder, bool createFoldForThisCollection, string collectionName)
-        {
-            return CreateScriptableObjectOfType(
-                targetType, AssetDatabase.GetAssetPath(parentFolder),
-                createFoldForThisCollection, collectionName);
-        }
-
         public static void GoToItem(ISOCItem socItem)
         {
             SessionState.SetInt(COLLECTION_CUSTOM_EDITOR_GO_TO_ITEM_INDEX_KEY, socItem.Collection.IndexOf(socItem));

Scripts/Runtime/Attributes/SOCItemEditorOptionsAttribute.cs

@@ -15,17 +15,24 @@ public enum LabelMode
         NoLabel = 1,
         //LabelOnSeparateLine = 2, // TODO
     }
-    
-#if UNITY_2022_2_OR_NEWER
-    [Obsolete("DrawAsSOCItemAttribute is not needed anymore, since Unity 2022 PropertyDrawers can be applied to interfaces")]
-#endif
-    [AttributeUsage(AttributeTargets.Field)]
-    public class DrawAsSOCItemAttribute : PropertyAttribute
+
+    public enum PreviewMode
     {
-        
+        /// <summary>
+        /// Defer to the project-wide default set in Project Settings &gt; Scriptable Object Collection.
+        /// </summary>
+        Default = 0,
+        /// <summary>
+        /// Draw the item's properties as an inline panel beneath the field.
+        /// </summary>
+        Inline = 1,
+        /// <summary>
+        /// Open Unity's floating Property Editor window for the item. Useful when third-party
+        /// inspectors (e.g. Odin) don't render correctly in the inline drawer.
+        /// </summary>
+        PropertyEditorWindow = 2,
     }
 
-    
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Class)]
     public class SOCItemEditorOptionsAttribute : Attribute
     {
@@ -35,6 +42,12 @@ public class SOCItemEditorOptionsAttribute : Attribute
 
         public bool ShouldDrawPreviewButton { get; set; } = true;
 
+        /// <summary>
+        /// Controls how the preview button reveals the item. <see cref="PreviewMode.Default"/>
+        /// falls back to the project-wide setting in <c>SOCSettings</c>.
+        /// </summary>
+        public PreviewMode PreviewMode { get; set; } = PreviewMode.Default;
+
         public string ValidateMethod { get; set; }
 
         /// <summary>
@@ -50,10 +63,4 @@ public class SOCItemEditorOptionsAttribute : Attribute
         /// </summary>
         public string OnSelectCallbackMethod { get; set; }
     }
-
-    //Temporary 
-    [Obsolete("CollectionItemEditorOptions is deprecated, please use SOCItemEditorOptionsAttribute instead.")]
-    public class CollectionItemEditorOptions : SOCItemEditorOptionsAttribute
-    {
-    }
 }