jp.keijiro.klutter-tools 1.0.0

package/Editor/CubeLutImporter.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using UnityEditor.AssetImporters;
+using UnityEngine;
+
+namespace Klak.KlutterTools {
+
+#if !KLUTTER_TOOLS_HAS_HDRP
+
+[ScriptedImporter(0, "cube")]
+class CubeLutImporter : ScriptedImporter
+{
+    #region ScriptedImporter implementation
+
+    public override void OnImportAsset(AssetImportContext ctx)
+    {
+        var (size, table) = ParseCubeFile(ctx.assetPath);
+
+        var tex = new Texture3D(size, size, size, TextureFormat.RGBAHalf, false);
+        tex.wrapMode = TextureWrapMode.Clamp;
+        tex.anisoLevel = 0;
+        tex.SetPixels(table);
+        tex.Apply();
+
+        ctx.AddObjectToAsset("3D Lookup Texture", tex);
+        ctx.SetMainObject(tex);
+    }
+
+    #endregion
+
+    #region Parser implementation
+
+    static bool CheckIfNumber(string word)
+      => '0' <= word[0] && word[0] <= '9';
+
+    static Color ParseColor(ReadOnlySpan<string> words)
+      => new Color(float.Parse(words[0]),
+                   float.Parse(words[1]),
+                   float.Parse(words[2]));
+
+    (int size, Color[] table) ParseCubeFile(string filePath)
+    {
+        var (size, table) = (0, new List<Color>());
+        foreach (var line in File.ReadLines(filePath))
+        {
+            var words = line.Split();
+            if (words.Length == 0 || words[0].Length == 0)
+                continue;
+            else if (words[0] == "LUT_3D_SIZE")
+                size = int.Parse(words[1]);
+            else if (CheckIfNumber(words[0]))
+                table.Add(ParseColor(words));
+        }
+        return (size, table.ToArray());
+    }
+
+    #endregion
+}
+
+#endif
+
+} // namespace Klak.KlutterTools 

package/Editor/CubeLutImporter.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 0ea948029d07949409ed8212c2287d15
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/FpsCapperSystem.cs

@@ -0,0 +1,56 @@
+using UnityEditor;
+using UnityEngine;
+using System.Threading;
+
+namespace Klak.KlutterTools {
+
+// FPS Capper player loop sub system
+[InitializeOnLoad]
+sealed class FpsCapperSystem
+{
+    // Synchronization object
+    static AutoResetEvent _sync;
+
+    // Interval in milliseconds
+    static int IntervalMsec;
+
+    // Interval thread function
+    static void IntervalThread()
+    {
+        for (_sync = new AutoResetEvent(true); true;)
+        {
+            Thread.Sleep(Mathf.Max(1, IntervalMsec));
+            _sync.Set();
+        }
+    }
+
+    // Custom system update function
+    static void UpdateSystem()
+    {
+        // Property update
+        IntervalMsec = 1000 / Mathf.Max(5, Preferences.FpsCapperFrameRate);
+
+        // Rejection cases
+        if (_sync == null) return;
+        if (!Preferences.FpsCapperEnable) return;
+        if (Preferences.FpsCapperFrameRate < 1) return;
+        if (Time.captureDeltaTime != 0) return;
+
+        // Synchronization with the interval thread
+        _sync.WaitOne();
+    }
+
+    // Static constructor
+    static FpsCapperSystem()
+    {
+        // Interval thread launch
+        new Thread(IntervalThread).Start();
+
+        // Player loop sub system installation
+        PlayerLoopHelper.AddToSubSystem
+          <UnityEngine.PlayerLoop.EarlyUpdate, FpsCapperSystem>
+          (UpdateSystem);
+    }
+}
+
+} // namespace Klak.KlutterTools 

package/Editor/FpsCapperSystem.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: a1f23e3597c3a4c03aa162ac21e404d5

package/Editor/KlutterTools.Editor.asmdef

@@ -0,0 +1,22 @@
+{
+    "name": "KlutterTools.Editor",
+    "rootNamespace": "",
+    "references": [],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [
+        {
+            "name": "com.unity.render-pipelines.high-definition",
+            "expression": "1.0.0",
+            "define": "KLUTTER_TOOLS_HAS_HDRP"
+        }
+    ],
+    "noEngineReferences": false
+}

package/Editor/KlutterTools.Editor.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 10ffe217b99824b2abaecc5725e7cbd5
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/PlayerLoopHelper.cs

@@ -0,0 +1,34 @@
+using System;
+using UnityEngine.LowLevel;
+
+namespace Klak.KlutterTools {
+
+public static class PlayerLoopHelper
+{
+    public static void AddToSubSystem<P, T>
+      (PlayerLoopSystem.UpdateFunction updateFunc)
+    {
+        var loop = PlayerLoop.GetCurrentPlayerLoop();
+
+        for (var i = 0; i < loop.subSystemList.Length; i++) 
+        {
+            ref var subsys = ref loop.subSystemList[i];
+            if (subsys.type != typeof(P)) continue;
+
+            var target = new PlayerLoopSystem 
+                { type = typeof(T), updateDelegate = updateFunc };
+
+            var len = subsys.subSystemList.Length;
+            Array.Resize(ref subsys.subSystemList, len + 1);
+            subsys.subSystemList[len] = target;
+
+            PlayerLoop.SetPlayerLoop(loop);
+            return;
+        }
+
+        throw new InvalidOperationException
+          ($"Can't find player sub system {typeof(P)}");
+    }
+}
+
+} // namespace Klak.KlutterTools 

package/Editor/PlayerLoopHelper.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: e133701f0d88549f4bea809b8dc60c86

package/Editor/PreferencesProvider.cs

@@ -0,0 +1,83 @@
+using UnityEditor;
+using UnityEngine;
+
+namespace Klak.KlutterTools {
+
+// Preference accessor
+public static class Preferences
+{
+    public static bool FpsCapperEnable
+      { get => EditorPrefs.GetBool(Keys.FpsCapperEnable, false);
+        set => EditorPrefs.SetBool(Keys.FpsCapperEnable, value); }
+
+    public static int FpsCapperFrameRate
+      { get => EditorPrefs.GetInt(Keys.FpsCapperFrameRate, 60);
+        set => EditorPrefs.SetInt(Keys.FpsCapperFrameRate, value); }
+
+    public static float VfxGraphZoomStep
+      { get => EditorPrefs.GetFloat(Keys.VfxGraphZoomStep, 1);
+        set => EditorPrefs.SetFloat(Keys.VfxGraphZoomStep, value); }
+
+    // Preference keys
+    static class Keys
+    {
+        public const string FpsCapperEnable
+          = "Klak.KlutterTools.FpsCapper.Enable";
+
+        public const string FpsCapperFrameRate
+          = "Klak.KlutterTools.FpsCapper.FrameRate";
+
+        public const string VfxGraphZoomStep
+          = "Klak.KlutterTools.VfxGraph.ZoomStep";
+    }
+}
+
+// Preference provider (GUI)
+public sealed class PreferencesProvider : SettingsProvider
+{
+    public PreferencesProvider()
+      : base("Preferences/Klutter Tools", SettingsScope.User) {}
+
+    public override void OnGUI(string search)
+    {
+        var h = EditorGUIUtility.singleLineHeight / 2;
+
+        GUILayout.BeginHorizontal();
+        GUILayout.Space(h);
+        GUILayout.BeginVertical();
+        GUILayout.Space(h);
+
+        EditorGUI.BeginChangeCheck();
+
+        var fc_enable = Preferences.FpsCapperEnable;
+        var fc_frameRate = Preferences.FpsCapperFrameRate;
+        var vg_zoomStep = Preferences.VfxGraphZoomStep;
+
+        GUILayout.Label("FPS Capper", EditorStyles.boldLabel);
+        fc_enable = EditorGUILayout.Toggle("Enable", fc_enable);
+        fc_frameRate = EditorGUILayout.IntField("Target Frame Rate", fc_frameRate);
+
+        GUILayout.Space(h);
+
+        GUILayout.Label("VFX Graph", EditorStyles.boldLabel);
+        vg_zoomStep = EditorGUILayout.FloatField("Zoom Step Scale", vg_zoomStep);
+
+        if (EditorGUI.EndChangeCheck())
+        {
+            Preferences.FpsCapperEnable = fc_enable;
+            Preferences.FpsCapperFrameRate = fc_frameRate;
+            Preferences.VfxGraphZoomStep = vg_zoomStep;
+        }
+
+        GUILayout.EndVertical();
+        GUILayout.EndHorizontal();
+
+        base.OnGUI(search);
+    }
+
+    [SettingsProvider]
+    public static SettingsProvider GetSettingsProvider()
+      => new PreferencesProvider();
+}
+
+} // namespace Klak.KlutterTools 

package/Editor/PreferencesProvider.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: f1aa585aa01724c8a884ea2491fa2056

package/Editor/VfxGraphZoomStepModifier.cs

@@ -0,0 +1,43 @@
+using System;
+using System.Reflection;
+using UnityEditor;
+
+namespace Klak.KlutterTools {
+
+[InitializeOnLoad]
+public static class VfxGraphZoomStepModifier
+{
+    static VfxGraphZoomStepModifier()
+      => EditorWindow.windowFocusChanged += OnWindowFocusChanged;
+
+    public static void OnWindowFocusChanged()
+    {
+        var target = EditorWindow.focusedWindow;
+
+        var vfxViewWindowType = Type.GetType
+          ("UnityEditor.VFX.UI.VFXViewWindow, Unity.VisualEffectGraph.Editor");
+
+        if (!vfxViewWindowType.IsInstanceOfType(target)) return;
+
+        var graphViewProperty = vfxViewWindowType.GetProperty
+          ("graphView",
+           BindingFlags.Public | BindingFlags.Instance | BindingFlags.NonPublic);
+
+        var graphView = graphViewProperty.GetValue(target);
+        if (graphView == null) return;
+
+        var vfxViewType = graphView.GetType();
+        var argTypes = new []
+          { typeof(float), typeof(float), typeof(float), typeof(float) };
+
+        var setupZoomMethod = vfxViewType.GetMethod
+          ("SetupZoom",
+           BindingFlags.Public | BindingFlags.Instance, null, argTypes, null);
+
+        var args = new object[]
+          { 0.125f, 8, 0.15f * Preferences.VfxGraphZoomStep, 1 };
+        setupZoomMethod.Invoke(graphView, args);
+    }
+}
+
+} // namespace Klak.KlutterTools 

package/Editor/VfxGraphZoomStepModifier.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: 2cd3627ad5817423faf0215896efecaf

package/Editor.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 787631df698ad455293f24c810d3cd60
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/LICENSE.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 0ffd030a0b8314cc18beeb7fe8916a9e
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/README.md

@@ -0,0 +1,43 @@
+# Klutter Tools
+
+![screenshot](https://github.com/user-attachments/assets/1e2284cd-ea4a-400e-958c-00feb970e180)
+
+**Klutter Tools** is a collection of Unity Editor extensions offering various
+utilities to enhance the editor workflow.
+
+## Features
+
+Currently, the package includes the following features:
+
+### FPS capper
+
+**FPS Capper** allows you to set preferences for limiting the frame rate in the
+Unity Editor. This is particularly useful when editing VFX Graphs in Edit Mode,
+as V-Sync settings are ignored in this mode, which can lead to unnecessary
+energy consumption, heat and fan noise.
+
+### Zoom step scaling in VFX Graph Editor
+
+This feature provides a preference setting to customize the zoom step scaling
+in the VFX Graph Editor. It's especially helpful for Mac users with a trackpad,
+where scroll gestures can feel overly sensitive and make precise editing
+difficult.
+
+### .cube LUT file import
+
+Adds support for importing `.cube` LUT (Look-Up Table) files, commonly used in
+video editing software. While this feature is natively available in HDRP, it’s
+beneficial for users who want to use it in URP.
+
+## System Requirements
+
+- Unity 6 or later
+
+## How to Install
+
+The Klutter Tools package (`jp.keijiro.klutter-tools`) can be installed via the
+"Keijiro" scoped registry using Package Manager. To add the registry to your
+project, please follow [these instructions].
+
+[these instructions]:
+  https://gist.github.com/keijiro/f8c7e8ff29bfe63d86b888901b82644c

package/README.md.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: b8e9fe2ee27e941d29a1b9d6880c9a5e
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "jp.keijiro.klutter-tools",
+  "displayName": "Klutter Tools",
+  "description": "Miscellaneous editor tools.",
+  "author": "Keijiro Takahashi",
+  "license": "Unlicense",
+  "dependencies": { },
+  "version": "1.0.0",
+  "unity": "6000.0",
+  "keywords": [ "unity" ]
+}
+
+
+

package/package.json.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: ccd52616445304b51b24782bd1aea123
+PackageManifestImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: