Merge pull request #193 from Agent-Healm/main

Adds PreviewMesh attribute to Tri-Inspector along with sample demonstrating parameter usages.

Author: vanifatovvlad

Editor.Extras/Drawers/PreviewMeshDrawer.cs

@@ -0,0 +1,308 @@
+using System;
+using TriInspector;
+using TriInspector.Drawers;
+using TriInspector.Elements;
+using TriInspector.Utilities;
+using UnityEditor;
+using UnityEngine;
+using Object = UnityEngine.Object;
+
+[assembly: RegisterTriAttributeDrawer(typeof(PreviewMeshDrawer), TriDrawerOrder.Decorator,
+    ApplyOnArrayElement = true)]
+    
+namespace TriInspector.Drawers
+{
+    public class PreviewMeshDrawer : TriAttributeDrawer<PreviewMeshAttribute>
+    {
+        private class PreviewMeshPicker : TriElement
+        {
+            private readonly TriProperty _property;
+            private readonly bool _useFoldout;
+
+            public PreviewMeshPicker(TriProperty property, bool useFoldout)
+            {
+                _property = property;
+                _useFoldout = useFoldout;
+            }
+
+            public override float GetHeight(float width)
+            {
+                return EditorGUIUtility.singleLineHeight;
+            }
+            public override void OnGUI(Rect position)
+            {
+                var pickerRect = position;
+                GUIContent label = new(_property.DisplayName);
+
+                if (_useFoldout)
+                {
+                    var prefixRect = new Rect(position)
+                    {
+                        height = EditorGUIUtility.singleLineHeight,
+                        xMax = position.xMin + EditorGUIUtility.labelWidth,
+                    };
+                    pickerRect = new Rect(position)
+                    {
+                        height = EditorGUIUtility.singleLineHeight,
+                        xMin = prefixRect.xMax,
+                    };
+
+                    TriEditorGUI.Foldout(prefixRect, _property);
+                    label = GUIContent.none;
+                }
+
+                EditorGUI.BeginChangeCheck();
+                Object obj = _property.Value as Object;
+                var asset = EditorGUI.ObjectField(pickerRect, label, obj, typeof(GameObject), true);
+                if (EditorGUI.EndChangeCheck())
+                {
+                    _property.SetValue(asset);
+                }
+            }
+        }
+
+        private class PreviewMesh : TriElement
+        {
+            private readonly int _height;
+            private readonly int _width;
+            private readonly TriProperty _property;
+            private readonly bool _useFoldout;
+            private readonly PreviewMeshRotationMethod _rotationMethod;
+
+            private PreviewRenderUtility _previewUtility;
+            private static Material _mat;
+            private Material GetMat
+            {
+                get
+                {
+                    if (_mat == null)
+                    {
+                        _mat = new Material(Shader.Find("Universal Render Pipeline/Lit"));
+                        _mat.color = new Color(0.4f, 0.7f, 0.4f);
+                    }
+                    return _mat;
+                }
+            }
+
+            private readonly float _c_ROTATION_SENSITIVITY = -0.5f;
+            private readonly float _c_ZOOM_SENSITIVITY = 0.1f;
+            private readonly float _c_ZOOM_SENSITIVITY_MIN = 2f;
+            private readonly float _c_ZOOM_SENSITIVITY_MAX = 10f;
+            private readonly float _c_MIN_WIDTH = 50f;
+            private readonly float _c_DEFAULT_CAMERA_DISTANCE = 4f;
+
+            private Quaternion _previewQuaternion;
+            private Mesh _sharedMesh;
+            private float _distance;
+
+            private Vector2 _previewDir = new(-20f, 0f);
+
+            #region Initialization
+            public PreviewMesh(TriProperty property, int size, int width, bool useFoldout, PreviewMeshRotationMethod rotationMethod)
+            {
+                _property = property;
+                _height = size;
+                _width = width;
+                _useFoldout = useFoldout;
+                _rotationMethod = rotationMethod;
+            }
+
+            protected override void OnAttachToPanel()
+            {
+                _previewUtility = new();
+                _property.ValueChanged += OnValueChanged;
+
+                // Setup lights
+                _previewUtility.lights[0].intensity = 1.3f;
+                _previewUtility.lights[0].transform.rotation = Quaternion.Euler(40f, 40f, 0);
+                _previewUtility.lights[1].intensity = 1.3f;
+
+                // Setup camera
+                _previewUtility.cameraFieldOfView = 30f;
+                _previewUtility.camera.nearClipPlane = 0.1f;
+                _previewUtility.camera.farClipPlane = 100f;
+                _previewUtility.camera.backgroundColor = Color.black;
+                _previewUtility.camera.clearFlags = CameraClearFlags.Color;
+
+                base.OnAttachToPanel();
+
+                GetMeshObject();
+            }
+
+            protected override void OnDetachFromPanel()
+            {
+                _previewUtility.Cleanup();
+                _previewUtility = null;
+
+                _property.ValueChanged -= OnValueChanged;
+
+                base.OnDetachFromPanel();
+            }
+
+            private void OnValueChanged(TriProperty property)
+            {
+                GetMeshObject();
+            }
+
+            public override float GetHeight(float width)
+            {
+                if (_sharedMesh == null)
+                {
+                    return 0f;
+                }
+                if (!_useFoldout || _property.IsExpanded)
+                {
+                    return _height;
+                }
+                return 0f;
+            }
+
+            public override void OnGUI(Rect position)
+            {
+                if (_sharedMesh == null)
+                {
+                    return;
+                }
+                float currentWidth = _width == -1 ? (int) position.width : _width;
+                currentWidth = Math.Max(currentWidth, _c_MIN_WIDTH);
+
+                if (position.height == 0f)
+                {
+                    return;
+                }
+
+                position = new Rect(position.x, position.y, currentWidth, _height);
+                _previewUtility.BeginPreview(position, GUIStyle.none);
+                _previewUtility.DrawMesh(_sharedMesh, Matrix4x4.TRS(Vector3.zero, _previewQuaternion, Vector3.one), GetMat, 0);
+                _previewUtility.camera.Render();
+
+                Texture result = _previewUtility.EndPreview();
+                
+                if (result)
+                {
+                    GUI.DrawTexture(position, result, ScaleMode.ScaleToFit, false);
+                }
+                if (position.Contains(Event.current.mousePosition))
+                {
+                    HandleMouseEvent(Event.current);
+                }
+            }
+
+            #endregion
+
+
+            #region Helper Function
+
+            private void GetMeshObject()
+            {
+                var obj = _property.Value as Object;
+
+                if (obj == null)
+                {
+                    _sharedMesh = null;
+                    return;
+                }
+
+                _previewQuaternion = Quaternion.Euler(_previewDir);
+                _distance = _c_DEFAULT_CAMERA_DISTANCE;
+
+                // Draw supported types
+                if (obj is Mesh mesh)
+                {
+                    _sharedMesh = mesh;
+                }
+                else if (obj is GameObject go)
+                {
+                    var mf = go.GetComponentInChildren<MeshFilter>();
+                    if (mf != null)
+                    {
+                        _sharedMesh = mf.sharedMesh;
+                    }
+                    else
+                    {
+                        Debug.Log("No MeshFilter found on GameObject.");
+                    }
+                }
+
+                if (_sharedMesh != null)
+                {
+                    UpdatePreviewCamera();
+                }
+            }
+
+            private void UpdatePreviewCamera()
+            {
+                var bounds = _sharedMesh.bounds;
+
+                // fallback bounds
+                if (bounds.size == Vector3.zero)
+                {
+                    bounds = new Bounds(Vector3.zero, Vector3.one);
+                }
+
+                var magnitude = bounds.extents.magnitude;
+                _previewUtility.camera.transform.position = bounds.center + Vector3.back * (magnitude * _distance);
+                _previewUtility.camera.transform.LookAt(bounds.center);
+            }
+
+            private void HandleMouseEvent(Event mouseEvent)
+            {
+                var shift = mouseEvent.shift;
+
+                switch (mouseEvent.type)
+                {
+                    case EventType.MouseDrag:
+                        var cameraMovement = mouseEvent.delta * _c_ROTATION_SENSITIVITY;
+                        HandlePreviewCameraRotation(cameraMovement);
+                        mouseEvent.Use();
+                        break;
+
+                    case EventType.ScrollWheel:
+                        _distance = Mathf.Clamp(_distance + mouseEvent.delta.x * _c_ZOOM_SENSITIVITY, _c_ZOOM_SENSITIVITY_MIN, _c_ZOOM_SENSITIVITY_MAX);
+                        if (shift)
+                        {
+                            UpdatePreviewCamera();
+                            mouseEvent.Use();
+                        }
+                        break;
+
+                    default:
+                        return;
+                }
+            }
+
+            private void HandlePreviewCameraRotation(Vector2 movement)
+            {
+                float pitch = movement.y;
+                float yaw = movement.x;
+
+                switch (_rotationMethod)
+                {
+                    case PreviewMeshRotationMethod.Clamped:
+                        _previewDir.x = Mathf.Clamp(pitch + _previewDir.x, -90f, 90);
+                        _previewDir.y += yaw;
+                        _previewQuaternion = Quaternion.Euler(_previewDir.x, 0, 0) * Quaternion.Euler(0, _previewDir.y, 0);
+                        break;
+                    case PreviewMeshRotationMethod.Freeform:
+                        _previewQuaternion = Quaternion.Euler(pitch, yaw, 0) * _previewQuaternion;
+                        break;
+                }
+                _previewQuaternion = Quaternion.Normalize(_previewQuaternion);
+            }
+
+            #endregion
+        }
+
+        public override TriElement CreateElement(TriProperty property, TriElement next)
+        {
+            var root = new TriBoxGroupElement(new TriBoxGroupElement.Props
+            {
+                titleMode = TriBoxGroupElement.TitleMode.Hidden,
+            });
+            root.AddChild(new PreviewMeshPicker(property, Attribute.UseFoldout));
+            root.AddChild(new PreviewMesh(property, Attribute.Height, Attribute.Width, Attribute.UseFoldout, Attribute.RotationMethod));
+            return root;
+        }
+
+    }
+}

Editor.Extras/Drawers/PreviewMeshDrawer.cs.meta

@@ -0,0 +1,29 @@
+using TriInspector;
+using UnityEngine;
+
+public class Decorators_PreviewMeshSample : ScriptableObject
+{
+    [Title("Shortcut")]
+    [InfoBox("Mouse click -> Rotate Mesh in preview")]
+    [InfoBox("Shift + Scroll wheel -> Zoom Mesh in preview")]
+
+    [LabelWidth(200f)]
+    [PreviewMesh]
+    public GameObject mesh;
+
+    [LabelWidth(200f)]
+    [PreviewMesh(300)]
+    public GameObject meshHeight;
+
+    [LabelWidth(200f)]
+    [PreviewMesh(200, 160)]
+    public GameObject myObjectLengthAndWidth;
+
+    [LabelWidth(200f)]
+    [PreviewMesh(200, 160, false)]
+    public GameObject meshNoFoldout;
+
+    [LabelWidth(200f)]
+    [PreviewMesh(200, 160, true, PreviewMeshRotationMethod.Freeform)]
+    public GameObject meshFreeformRotation;
+}

Editor.Samples/Decorators/Decorators_PreviewMeshSample.cs

@@ -288,6 +288,24 @@ public float lengthInMeters;
 public float freeTextUnit;
 ```
 
+#### Preview Mesh
+
+![Preview Mesh](https://github.com/user-attachments/assets/d589a769-dc55-4e96-b0cc-edcde2677760)
+
+```csharp
+[LabelWidth(270f)]
+[PreviewMesh(100, 100)]
+public GameObject meshCustomLengthAndWidth;
+
+[LabelWidth(200f)]
+[PreviewMesh(200, 160, false)]
+public GameObject meshNoFoldoutNoMesh;
+
+[LabelWidth(200f)]
+[PreviewMesh(200, 160, false)]
+public GameObject meshNoFoldoutWithMesh;
+```
+
 ### Styling
 
 #### Title