// Animancer // https://kybernetik.com.au/animancer // Copyright 2018-2024 Kybernetik //
#if UNITY_EDITOR && UNITY_IMGUI
using Animancer.Editor.Tools;
using Animancer.Units;
using Animancer.Units.Editor;
using System;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using Object = UnityEngine.Object;
namespace Animancer.Editor
{
/// [Editor-Only]
/// A custom Inspector for s which allows you to directly edit them instead of just showing
/// their details like the default one does.
///
/// https://kybernetik.com.au/animancer/api/Animancer.Editor/SpriteEditor
[CustomEditor(typeof(Sprite), true), CanEditMultipleObjects]
public class SpriteEditor : UnityEditor.Editor
{
/************************************************************************************************************************/
private const string
NameTooltip = "The asset name of the sprite",
RectTooltip = "The texture area occupied by the sprite",
PivotTooltip = "The origin point of the sprite relative to its Rect",
BorderTooltip = "The edge sizes used when 9-Slicing the sprite for the UI system (ignored by SpriteRenderers)";
[NonSerialized]
private SerializedProperty
_Name,
_Rect,
_Pivot,
_Border;
[NonSerialized]
private NormalizedPixelField[]
_RectFields,
_PivotFields,
_BorderFields;
[NonSerialized]
private bool _HasBeenModified;
[NonSerialized]
private Target[] _Targets;
private readonly struct Target
{
public readonly Sprite Sprite;
public readonly string AssetPath;
public readonly TextureImporter Importer;
public Target(Object target)
{
Sprite = target as Sprite;
AssetPath = AssetDatabase.GetAssetPath(target);
Importer = AssetImporter.GetAtPath(AssetPath) as TextureImporter;
}
}
/************************************************************************************************************************/
/// Initializes this editor.
protected virtual void OnEnable()
{
var targets = this.targets;
_Targets = new Target[targets.Length];
for (int i = 0; i < targets.Length; i++)
_Targets[i] = new(targets[i]);
InitializePreview();
_Name = serializedObject.FindProperty($"m{nameof(_Name)}");
_Rect = serializedObject.FindProperty($"m{nameof(_Rect)}");
if (_Rect != null)
{
_RectFields = new NormalizedPixelField[]
{
new(_Rect.FindPropertyRelative(nameof(Rect.x)), new("X (Left)",
"The distance from the left edge of the texture to the left edge of the sprite"), false),
new(_Rect.FindPropertyRelative(nameof(Rect.y)), new("Y (Bottom)",
"The distance from the bottom edge of the texture to the bottom edge of the sprite"), false),
new(_Rect.FindPropertyRelative(nameof(Rect.width)), new("Width",
"The horizontal size of the sprite"), false),
new(_Rect.FindPropertyRelative(nameof(Rect.height)), new("Height",
"The vertical size of the sprite"), false),
};
}
_Pivot = serializedObject.FindProperty($"m{nameof(_Pivot)}");
if (_Pivot != null)
{
_PivotFields = new NormalizedPixelField[]
{
new(_Pivot.FindPropertyRelative(nameof(Vector2.x)), new("X",
"The horizontal distance from the left edge of the sprite to the pivot point"), true),
new(_Pivot.FindPropertyRelative(nameof(Vector2.y)), new("Y",
"The vertical distance from the bottom edge of the sprite to the pivot point"), true),
};
}
_Border = serializedObject.FindProperty($"m{nameof(_Border)}");
if (_Border != null)
{
_BorderFields = new NormalizedPixelField[]
{
new(_Border.FindPropertyRelative(nameof(Vector4.x)), new("Left",
BorderTooltip), false),
new(_Border.FindPropertyRelative(nameof(Vector4.y)), new("Bottom",
BorderTooltip), false),
new(_Border.FindPropertyRelative(nameof(Vector4.z)), new("Right",
BorderTooltip), false),
new(_Border.FindPropertyRelative(nameof(Vector4.w)), new("Top",
BorderTooltip), false),
};
}
}
/************************************************************************************************************************/
/// Cleans up this editor.
protected virtual void OnDisable()
{
CleanUpPreview();
if (_HasBeenModified)
{
var sprite = target as Sprite;
if (sprite == null)
return;
if (EditorUtility.DisplayDialog("Unapplied Import Settings",
$"Unapplied import settings for '{sprite.name}' in '{AssetDatabase.GetAssetPath(sprite)}'",
nameof(Apply), nameof(Revert)))
Apply();
}
}
/************************************************************************************************************************/
#region Inspector
/************************************************************************************************************************/
/// Are all targets set to ?
private bool AllSpriteModeMultiple
{
get
{
for (int i = 0; i < _Targets.Length; i++)
{
var importer = _Targets[i].Importer;
if (importer == null ||
importer.spriteImportMode != SpriteImportMode.Multiple)
return false;
}
return true;
}
}
/************************************************************************************************************************/
/// Called by the Unity editor to draw the custom Inspector GUI elements.
public override void OnInspectorGUI()
{
EditorGUI.BeginChangeCheck();
DoNameGUI();
// If any target isn't set to Multiple, disable the GUI because only renaming will work.
var enabled = GUI.enabled;
if (!AllSpriteModeMultiple)
GUI.enabled = false;
DoRectGUI();
DoPivotGUI();
DoBorderGUI();
GUI.enabled = enabled;
if (EditorGUI.EndChangeCheck())
_HasBeenModified = true;
GUILayout.Space(AnimancerGUI.StandardSpacing);
GUILayout.BeginHorizontal();
{
GUILayout.FlexibleSpace();
GUI.enabled = _HasBeenModified;
if (GUILayout.Button(nameof(Revert)))
Revert();
if (GUILayout.Button(nameof(Apply)))
Apply();
}
GUILayout.EndHorizontal();
}
/************************************************************************************************************************/
private void DoNameGUI()
{
GUILayout.BeginHorizontal();
var enabled = GUI.enabled;
if (_Name.hasMultipleDifferentValues)
GUI.enabled = false;
using (var label = PooledGUIContent.Acquire("Name", NameTooltip))
EditorGUILayout.PropertyField(_Name, label, true);
GUI.enabled = true;
var changed = EditorGUI.EndChangeCheck();// Exclude the Rename button from the main change check.
if (GUILayout.Button("Rename Tool", EditorStyles.miniButton, AnimancerGUI.DontExpandWidth))
AnimancerToolsWindow.Open(typeof(RenameSpritesTool));
EditorGUI.BeginChangeCheck();
AnimancerGUI.SetGuiChanged(changed);
GUI.enabled = enabled;
GUILayout.EndHorizontal();
}
/************************************************************************************************************************/
private void DoRectGUI()
{
var texture = ((Sprite)target).texture;
_RectFields[0].normalizeMultiplier = _RectFields[2].normalizeMultiplier = 1f / texture.width;
_RectFields[1].normalizeMultiplier = _RectFields[3].normalizeMultiplier = 1f / texture.height;
using (var label = PooledGUIContent.Acquire("Rect", RectTooltip))
NormalizedPixelField.DoGroupGUI(_Rect, label, _RectFields);
}
/************************************************************************************************************************/
private void DoPivotGUI()
{
var showMixedValue = EditorGUI.showMixedValue;
var targets = this.targets;
var size = targets[0] is Sprite sprite ? sprite.rect.size : Vector2.one;
for (int i = 1; i < targets.Length; i++)
{
sprite = targets[i] as Sprite;
if (sprite == null || !sprite.rect.size.Equals(size))
EditorGUI.showMixedValue = true;
}
_PivotFields[0].normalizeMultiplier = 1f / size.x;
_PivotFields[1].normalizeMultiplier = 1f / size.y;
using (var label = PooledGUIContent.Acquire("Pivot", PivotTooltip))
NormalizedPixelField.DoGroupGUI(_Pivot, label, _PivotFields);
EditorGUI.showMixedValue = showMixedValue;
}
/************************************************************************************************************************/
private void DoBorderGUI()
{
var size = _Rect.rectValue.size;
_BorderFields[0].normalizeMultiplier = _BorderFields[2].normalizeMultiplier = 1f / size.x;
_BorderFields[1].normalizeMultiplier = _BorderFields[3].normalizeMultiplier = 1f / size.y;
using (var label = PooledGUIContent.Acquire("Border", BorderTooltip))
NormalizedPixelField.DoGroupGUI(_Border, label, _BorderFields);
}
/************************************************************************************************************************/
private void Revert()
{
AnimancerGUI.Deselect();
_HasBeenModified = false;
serializedObject.Update();
}
/************************************************************************************************************************/
private void Apply()
{
AnimancerGUI.Deselect();
_HasBeenModified = false;
var targets = this.targets;
var hasError = false;
for (int i = 0; i < _Targets.Length; i++)
{
var target = _Targets[i];
if (target.Sprite == null ||
target.Importer == null)
continue;
var data = new SpriteDataEditor(target.Importer);
Apply(data, target.Sprite, ref hasError);
if (!hasError)
data.Apply();
}
for (int i = 0; i < targets.Length; i++)
if (targets[i] == null)
return;
serializedObject.Update();
}
/************************************************************************************************************************/
private void Apply(SpriteDataEditor data, Sprite sprite, ref bool hasError)
{
if (data.SpriteCount == 0)
{
if (!_Name.hasMultipleDifferentValues)
{
var path = AssetDatabase.GetAssetPath(sprite);
if (path != null)
{
AssetDatabase.RenameAsset(path, _Name.stringValue);
hasError = true;// Don't apply the importer.
}
}
return;
}
var index = data.IndexOf(sprite);
if (index < 0)
{
hasError = true;
return;
}
if (!_Name.hasMultipleDifferentValues)
data.SetName(index, _Name.stringValue);
if (!_Rect.hasMultipleDifferentValues)
data.SetRect(index, _Rect.rectValue);
if (!_Pivot.hasMultipleDifferentValues)
data.SetPivot(index, _Pivot.vector2Value);
if (!_Border.hasMultipleDifferentValues)
data.SetBorder(index, _Border.vector4Value);
if (!data.ValidateBounds(index, sprite))
hasError = true;
}
/************************************************************************************************************************/
#region Normalized Pixel Field
/************************************************************************************************************************/
///
/// A wrapper around a to display it using two float fields where one is
/// normalized and the other is not.
///
private class NormalizedPixelField
{
/************************************************************************************************************************/
/// The target property.
public readonly SerializedProperty Property;
/// The label to display next to the property.
public readonly GUIContent Label;
/// Is the serialized property value normalized?
public readonly bool IsNormalized;
/// The multiplier to turn a non-normalized value into a normalized one.
public float normalizeMultiplier;
/************************************************************************************************************************/
/// Creates a new .
public NormalizedPixelField(SerializedProperty property, GUIContent label, bool isNormalized)
{
Property = property;
Label = label;
IsNormalized = isNormalized;
}
/************************************************************************************************************************/
/// Draws a group of s.
public static void DoGroupGUI(SerializedProperty baseProperty, GUIContent label, NormalizedPixelField[] fields)
{
var height = (AnimancerGUI.LineHeight + AnimancerGUI.StandardSpacing) * (fields.Length + 1);
var area = AnimancerGUI.LayoutRect(height);
area.height = AnimancerGUI.LineHeight;
label = EditorGUI.BeginProperty(area, label, baseProperty);
GUI.Label(area, label);
EditorGUI.EndProperty();
EditorGUI.indentLevel++;
for (int i = 0; i < fields.Length; i++)
{
AnimancerGUI.NextVerticalArea(ref area);
fields[i].DoTwinFloatFieldGUI(area);
}
EditorGUI.indentLevel--;
}
/************************************************************************************************************************/
/// Draws this .
public void DoTwinFloatFieldGUI(Rect area)
{
var attribute = IsNormalized ?
NormalizedPixelFieldAttribute.Normalized :
NormalizedPixelFieldAttribute.Pixel;
var drawer = IsNormalized ?
NormalizedPixelFieldAttributeDrawer.Normalized :
NormalizedPixelFieldAttributeDrawer.Pixel;
attribute.CalculateMultipliers(normalizeMultiplier);
drawer.OnGUI(area, Property, Label);
}
/************************************************************************************************************************/
}
/************************************************************************************************************************/
#endregion
/************************************************************************************************************************/
#region Normalized Pixel Field
/************************************************************************************************************************/
private class NormalizedPixelFieldAttribute : UnitsAttribute
{
/************************************************************************************************************************/
private static new readonly float[] Multipliers = new float[2];
public void CalculateMultipliers(float normalizeMultiplier)
{
if (UnitIndex == 0)// Pixels.
{
Multipliers[0] = 1;
Multipliers[1] = normalizeMultiplier;
}
else// Normalized.
{
Multipliers[0] = 1f / normalizeMultiplier;
Multipliers[1] = 1;
}
}
/************************************************************************************************************************/
private static new readonly string[] Suffixes =
{
"px",
"x",
};
/************************************************************************************************************************/
public static readonly NormalizedPixelFieldAttribute Pixel = new(false);
public static readonly NormalizedPixelFieldAttribute Normalized = new(true);
/************************************************************************************************************************/
public NormalizedPixelFieldAttribute(bool isNormalized)
: base(Multipliers, Suffixes, isNormalized ? 1 : 0)
{
Rule = Validate.Value.IsFinite;
}
/************************************************************************************************************************/
}
/************************************************************************************************************************/
[CustomPropertyDrawer(typeof(NormalizedPixelFieldAttribute), true)]
private class NormalizedPixelFieldAttributeDrawer : UnitsAttributeDrawer
{
/************************************************************************************************************************/
public static readonly NormalizedPixelFieldAttributeDrawer Pixel = new();
public static readonly NormalizedPixelFieldAttributeDrawer Normalized = new();
static NormalizedPixelFieldAttributeDrawer()
{
Pixel.Initialize(NormalizedPixelFieldAttribute.Pixel);
Normalized.Initialize(NormalizedPixelFieldAttribute.Normalized);
}
/************************************************************************************************************************/
///
protected override int GetLineCount(SerializedProperty property, GUIContent label)
=> 1;
/************************************************************************************************************************/
}
/************************************************************************************************************************/
#endregion
/************************************************************************************************************************/
#endregion
/************************************************************************************************************************/
#region Preview
/************************************************************************************************************************/
private static readonly Type
DefaultEditorType = typeof(UnityEditor.Editor).Assembly.GetType("UnityEditor.SpriteInspector");
private readonly Dictionary