Merge branch 'release/1.2.0'

Author: kleber-swf

CHANGELOG.md

@@ -5,8 +5,63 @@ 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.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [1.2.0]
+
+### Added
+
+-  Guess rows and cols based on the texture
+-  Showing error for Custom Character Properties when the given character is empty
+-  Monospaced font to characters (under testing)
+-  Character count
+
+### Changed
+
+-  Ignoring \n characters to make it easier to add them to the characters field
+
+---
+
+## [1.1.1]
+
+### Fixed
+
+-  Resources folder creation at startup
+
+---
+
+## [1.1.0]
+
+### Added
+
+-  All error checks for font creation
+-  Warning when the material or font settings already exists
+-  Local options popup
+-  Warn before replacing current settings
+-  Warn on replace profile preference
+-  Rollback button
+-  Setting readonly editor - to avoid changing settings directly in the file and creating inconsistencies
+
+### Changed
+
+-  Loading selected profile on open
+
+### Removed
+
+-  Unecessary example folder
+
+### Fixed
+
+-  Prefereces creation
+-  Specific data for examples
+-  Canceling settings override doesn't swap profile anymore
+-  When changing to no profile, no setting changes, thus no dialog should be displayed
+-  Error when checking settings for the first time
+
+---
+
 ## [1.0.0]
 
 Initial version
 
-[1.0.0]: https://github.com/kleber-swf/unity-bitmap-font-creator/releases/tag/1.0.0
+[1.1.1]: https://github.com/kleber-swf/unity-bitmap-font-creator/releases/tag/1.1.1
+[1.1.0]: https://github.com/kleber-swf/unity-bitmap-font-creator/releases/tag/1.1.0
+[1.0.0]: https://github.com/kleber-swf/unity-bitmap-font-creator/releases/tag/1.0.0

Documentation/screenshot-01.png

@@ -7,14 +7,12 @@ namespace dev.klebersilva.tools.bitmapfontcreator
 {
 	internal static class BitmapFontCreator
 	{
-		public static void TryCreateFont(ExecutionData data, bool warnBeforeOverwrite)
+		private const char IgnoreCharacter = ' ';
+
+		public static bool TryCreateFont(ExecutionData data, bool warnBeforeOverwrite, out string error)
 		{
-			var error = CheckForErrors(data);
-			if (!string.IsNullOrEmpty(error))
-			{
-				Debug.LogError(error);
-				return;
-			}
+			error = CheckForErrors(data);
+			if (!string.IsNullOrEmpty(error)) return false;
 
 			var path = AssetDatabase.GetAssetPath(data.Texture);
 			var baseName = Path.GetFileNameWithoutExtension(path);
@@ -25,16 +23,18 @@ public static void TryCreateFont(ExecutionData data, bool warnBeforeOverwrite)
 			if (warnBeforeOverwrite && !(AssetDatabase.GUIDFromAssetPath(materialPath) == null && AssetDatabase.GUIDFromAssetPath(fontPath) == null))
 			{
 				if (!EditorUtility.DisplayDialog("Warning", "Asset already exists. Overwrite? (It will keep the references)", "Yes", "No"))
-					return;
+					return false;
 			}
 
 			var material = CreateMaterial(baseName, data.Texture);
-			var font = CreateFontAsset(baseName, material, data);
+			var font = CreateFontAsset(baseName, material, data, out error);
+			if (!string.IsNullOrEmpty(error)) return false;
 
 			AssetDatabase.CreateAsset(material, materialPath);
 			CreateOrReplaceAsset(font, fontPath);
 
 			AssetDatabase.Refresh();
+			return true;
 		}
 
 		private static string CheckForErrors(ExecutionData data)
@@ -45,8 +45,8 @@ private static string CheckForErrors(ExecutionData data)
 			if (data.Texture == null) return "Texture cannot be null";
 			if (!data.Texture.isReadable) return "Texture must be readable. Set Read/Write Enabled to true inside Texture Properties";
 
-			if (data.Characters.Length != data.Cols * data.Rows)
-				return $"Characters length ({data.Characters.Length}) must be equal to Cols ({data.Cols}) * Rows ({data.Rows})";
+			if (data.ValidCharactersCount != data.Cols * data.Rows)
+				return $"Characters length ({data.ValidCharactersCount}) must be equal to Cols ({data.Cols}) * Rows ({data.Rows})";
 
 			return null;
 		}
@@ -60,11 +60,20 @@ private static Material CreateMaterial(string baseName, Texture2D texture)
 			};
 		}
 
-		private static Font CreateFontAsset(string baseName, Material material, ExecutionData data)
+		private static Font CreateFontAsset(string baseName, Material material, ExecutionData data, out string error)
 		{
+			error = null;
 			var map = new Dictionary<char, CharacterProps>();
-			foreach (var e in data.CustomCharacterProps)
+			for (var i = 0; i < data.CustomCharacterProps.Count; i++)
+			{
+				var e = data.CustomCharacterProps[i];
+				if (string.IsNullOrEmpty(e.Character))
+				{
+					error = $"Character for Custom Character Properties at position {i + 1} is empty";
+					return null;
+				}
 				map.Add(e.Character[0], e);
+			}
 
 			return new Font(baseName)
 			{
@@ -83,16 +92,15 @@ private static CharacterInfo[] CreateCharacters(ExecutionData data, Dictionary<c
 			int xMin, xMax, advance;
 			int largestAdvance = 0;
 
-			// horizontal
 			for (var row = 0; row < data.Rows; row++)
 			{
 				for (var col = 0; col < data.Cols; col++)
 				{
 					var i = data.Orientation == Orientation.Horizontal
 						? (row * data.Cols) + col
 						: (col * data.Rows) + row;
-					var ch = data.Characters[i];
-					if (ch == ' ' || ch == '\r' || ch == '\n') continue;
+					var ch = data.ValidCharacters[i];
+					if (ch == IgnoreCharacter) continue;
 
 					GetCharacterBounds(
 						tex: data.Texture,
@@ -174,5 +182,67 @@ private static void CreateOrReplaceAsset<T>(T asset, string path) where T : Obje
 				AssetDatabase.SaveAssets();
 			}
 		}
+
+		public static Vector2Int GuessRowsAndCols(Texture2D tex)
+		{
+			var rows = 0;
+			var cols = 0;
+
+			uint state = 0;   // 0 = looking for not transparent, 1 = looking for transparent
+			bool foundNonTransparentPixel;
+
+			for (var x = 0; x < tex.width; x++)
+			{
+				foundNonTransparentPixel = false;
+				for (var y = 0; y < tex.height; y++)
+				{
+					if (tex.GetPixel(x, y).a == 0) continue;
+					foundNonTransparentPixel = true;
+					break;
+				}
+
+				if (state == 0)
+				{
+					if (foundNonTransparentPixel)
+					{
+						state = 1;
+						cols++;
+					}
+				}
+				else
+				{
+					if (!foundNonTransparentPixel)
+						state = 0;
+				}
+			}
+
+			state = 0;
+			for (var y = 0; y < tex.height; y++)
+			{
+				foundNonTransparentPixel = false;
+				for (var x = 0; x < tex.width; x++)
+				{
+					if (tex.GetPixel(x, y).a == 0) continue;
+					foundNonTransparentPixel = true;
+					break;
+				}
+
+				if (state == 0)
+				{
+					if (foundNonTransparentPixel)
+					{
+						state = 1;
+						rows++;
+					}
+				}
+				else
+				{
+					if (!foundNonTransparentPixel)
+						state = 0;
+				}
+			}
+
+			return new(rows, cols);
+		}
 	}
 }

Editor/BitmapFontCreator.cs

@@ -17,9 +17,12 @@ internal class CharacterProps
 		public int Spacing = 0;
 	}
 
-	internal class BitmapFontCreatorData
+	[Serializable]
+	internal class BitmapFontCreatorData : ISerializationCallbackReceiver
 	{
-		public string Characters;
+		private const string IgnoreCharacter = "\n";
+
+		[SerializeField] private string _characters = string.Empty;
 		public Orientation Orientation;
 		public int Cols;
 		public int Rows;
@@ -28,11 +31,25 @@ internal class BitmapFontCreatorData
 		public int DefaultCharacterSpacing;
 		public List<CharacterProps> CustomCharacterProps;
 
+		public string Characters
+		{
+			get { return _characters; }
+			set
+			{
+				if (_characters == value) return;
+				_characters = value;
+				UpdateChacters();
+			}
+		}
+
+		public string ValidCharacters { get; protected set; } = string.Empty;
+		public int ValidCharactersCount { get; protected set; } = 0;
+
 		public virtual void CopyTo(BitmapFontCreatorData dest)
 		{
 			if (dest == null) return;
 
-			dest.Characters = Characters;
+			dest.Characters = _characters;
 			dest.Orientation = Orientation;
 			dest.Cols = Cols;
 			dest.Rows = Rows;
@@ -45,7 +62,19 @@ public virtual void CopyTo(BitmapFontCreatorData dest)
 
 			foreach (var e in CustomCharacterProps)
 				dest.CustomCharacterProps.Add(new CharacterProps() { Character = e.Character, Spacing = e.Spacing });
+
+			UpdateChacters();
 		}
+
+		// TODO this should be called automatically when the field Characters changes
+		private void UpdateChacters()
+		{
+			ValidCharacters = _characters.Replace(IgnoreCharacter, string.Empty);
+			ValidCharactersCount = ValidCharacters.Length;
+		}
+
+		public void OnBeforeSerialize() { }
+		public void OnAfterDeserialize() { UpdateChacters(); }
 	}
 
 	internal class ExecutionData : BitmapFontCreatorData
@@ -55,14 +84,16 @@ internal class ExecutionData : BitmapFontCreatorData
 		public static ExecutionData Default => new()
 		{
 			Texture = null,
-			Characters = "",
+			Characters = string.Empty,
 			Orientation = Orientation.Horizontal,
 			Cols = 1,
 			Rows = 1,
 			AlphaThreshold = 0f,
 			DefaultCharacterSpacing = 10,
 			Monospaced = false,
 			CustomCharacterProps = new List<CharacterProps>(),
+			ValidCharacters = string.Empty,
+			ValidCharactersCount = 0
 		};
 	}
 }