Added Unit Attribute and Sample Usage (#181)

Author: Kinggrass

Editor.Extras/Drawers/UnitDrawer.cs

@@ -0,0 +1,45 @@
+using TriInspector;
+using TriInspector.Drawers;
+using UnityEditor;
+using UnityEngine;
+
+[assembly: RegisterTriAttributeDrawer(typeof(UnitDrawer), TriDrawerOrder.Decorator)]
+
+namespace TriInspector.Drawers
+{
+    public class UnitDrawer : TriAttributeDrawer<UnitAttribute>
+    {
+        /// <summary>
+        /// Defines the padding to the right of the unit label towards the editable input field
+        /// </summary>
+        private const int paddingRight = 5;
+        private GUIStyle unitStyle;
+        private GUIContent content;
+
+        public override void OnGUI(Rect position, TriProperty property, TriElement next)
+        {
+            if(unitStyle == null){
+                unitStyle = new(EditorStyles.label);
+            }
+
+            if(content == null){
+                content = new(Attribute.unitToDisplay);
+            }
+
+            Vector2 size = unitStyle.CalcSize(content);
+
+            var unitRect = new Rect(position.xMax - size.x - paddingRight, position.y, size.x, position.height);
+
+            // Render the editable input field
+            next.OnGUI(position);
+
+            //Change color to grey
+            var tmpColor = GUI.color;
+            GUI.color = Color.grey;
+            // Render the unit as a suffix in the unitRect
+            EditorGUI.LabelField(unitRect, content);
+            // Restore the original color
+            GUI.color = tmpColor;
+        }
+    }
+}

Editor.Extras/Drawers/UnitDrawer.cs.meta

@@ -0,0 +1,111 @@
+using System.Collections.Generic;
+using TriInspector;
+using UnityEngine;
+
+public class Decorators_UnitSample : ScriptableObject
+{
+    [Unit("My custom Unit")]
+    public float freeTextUnit;
+
+    [Unit(UnitAttribute.Meter)]
+    public float lengthInMeters;
+
+    [Unit(UnitAttribute.Centimeter)]
+    public float lengthInCentimeters;
+
+    [Unit(UnitAttribute.Millimeter)]
+    public float lengthInMillimeters;
+
+    [Unit(UnitAttribute.Kilogram)]
+    public float massInKilograms;
+
+    [Unit(UnitAttribute.Gram)]
+    public float massInGrams;
+
+    [Unit(UnitAttribute.Second)]
+    public float timeInSeconds;
+
+    [Unit(UnitAttribute.Ampere)]
+    public float electricCurrentInAmperes;
+
+    [Unit(UnitAttribute.Kelvin)]
+    public float temperatureInKelvins;
+
+    [Unit(UnitAttribute.Celsius)]
+    public float temperatureInCelsius;
+
+    [Unit(UnitAttribute.Mole)]
+    public float amountOfSubstanceInMoles;
+
+    [Unit(UnitAttribute.Candela)]
+    public float luminousIntensityInCandelas;
+
+    [Unit(UnitAttribute.Radian)]
+    public float angleInRadians;
+
+    [Unit(UnitAttribute.Degree)]
+    public float angleInDegrees;
+
+    [Unit(UnitAttribute.Liter)]
+    public float volumeInLiters;
+
+    [Unit(UnitAttribute.Hertz)]
+    public float frequencyInHertz;
+
+    [Unit(UnitAttribute.Newton)]
+    public float forceInNewtons;
+
+    [Unit(UnitAttribute.Pascal)]
+    public float pressureInPascals;
+
+    [Unit(UnitAttribute.Joule)]
+    public float energyInJoules;
+
+    [Unit(UnitAttribute.Watt)]
+    public float powerInWatts;
+
+    [Unit(UnitAttribute.Coulomb)]
+    public float electricChargeInCoulombs;
+
+    [Unit(UnitAttribute.Volt)]
+    public float electricPotentialInVolts;
+
+    [Unit(UnitAttribute.Ohm)]
+    public float resistanceInOhms;
+
+    [Unit(UnitAttribute.Farad)]
+    public float capacitanceInFarads;
+
+    [Unit(UnitAttribute.Tesla)]
+    public float magneticFluxDensityInTeslas;
+
+    [Unit(UnitAttribute.Lux)]
+    public float illuminanceInLux;
+
+    [Unit(UnitAttribute.Weber)]
+    public float magneticFluxInWebers;
+
+    [Unit(UnitAttribute.Sievert)]
+    public float doseEquivalentInSieverts;
+
+    [Unit(UnitAttribute.Henry)]
+    public float inductanceInHenrys;
+
+    [Unit(UnitAttribute.Siemens)]
+    public float conductanceInSiemens;
+
+    [Unit(UnitAttribute.Becquerel)]
+    public float radioactivityInBecquerels;
+
+    [Unit(UnitAttribute.Gray)]
+    public float absorbedDoseInGrays;
+
+    [Unit(UnitAttribute.Katal)]
+    public float catalyticActivityInKatals;
+
+    [Unit(UnitAttribute.MeterPerSecond)]
+    public float speedInMetersPerSecond;
+
+    [Unit(UnitAttribute.MeterPerSquareSecond)]
+    public float accelerationInMetersPerSquareSecond;
+}

Editor.Samples/Decorators/Decorators_UnitSample.cs

@@ -276,6 +276,24 @@ public Material mat;
 public string[] collection = {"hello", "world"};
 ```
 
+#### Unit
+
+![Unit](https://github.com/user-attachments/assets/7b40aa28-cb5f-4764-9ec1-19ed95b12803)
+
+```csharp
+[Unit("My custom Unit")]
+public float freeTextUnit;
+
+[Unit(UnitAttribute.Meter)]
+public float lengthInMeters;
+
+[Unit(UnitAttribute.Centimeter)]
+public float lengthInCentimeters;
+
+[Unit(UnitAttribute.Millimeter)]
+public float lengthInMillimeters;
+```
+
 ### Styling
 
 #### Title

Editor.Samples/Decorators/Decorators_UnitSample.cs.meta

@@ -0,0 +1,62 @@
+using System;
+using System.Diagnostics;
+
+namespace TriInspector
+{
+    [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
+    [Conditional("UNITY_EDITOR")]
+    public class UnitAttribute : Attribute
+    {
+        public string unitToDisplay;
+
+#region Base Units
+        public const string Meter = "m";
+        public const string Centimeter = "cm";
+        public const string Millimeter = "mm";
+        public const string Kilogram = "kg";
+        public const string Second = "s";
+        public const string Ampere = "A";
+        public const string Kelvin = "K";
+        public const string Mole = "mol";
+        public const string Candela = "cd";
+#endregion
+
+#region Derived Units
+        public const string Radian = "rad";
+        public const string Degree = "°";
+        public const string Gram = "g";
+        public const string Liter = "L";
+        public const string Hertz = "Hz";
+        public const string Newton = "N";
+        public const string Pascal = "Pa";
+        public const string Joule = "J";
+        public const string Watt = "W";
+        public const string Coulomb = "C";
+        public const string Volt = "V";
+        public const string Ohm = "Ω";
+        public const string Farad = "F";
+        public const string Tesla = "T";
+        public const string Celsius = "°C";
+#endregion
+
+#region Common Combinations
+        public const string MeterPerSecond = "m/s";
+        public const string MeterPerSquareSecond = "m/s²";
+#endregion
+
+#region Extended Physics Units
+        public const string Lux = "lx";
+        public const string Weber = "Wb";
+        public const string Sievert = "Sv";
+        public const string Henry = "H";
+        public const string Siemens = "S";
+        public const string Becquerel = "Bq";
+        public const string Gray = "Gy";
+        public const string Katal = "kat";
+#endregion
+
+        public UnitAttribute(string unit){
+            unitToDisplay = unit;
+        }
+    }
+}