using System.Collections.Generic; using System.Globalization; using System.IO; using System.Text.RegularExpressions; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Content; using Microsoft.Xna.Framework.Graphics; using MLEM.Textures; namespace MLEM.Data { /// /// /// This class represents an atlas of objects which are loaded from a special texture atlas file. /// To load a data texture atlas, you can use . /// /// /// Data texture atlases are designed to be easy to write by hand. Because of this, their structure is very simple. /// Each texture region defined in the atlas consists of its name, followed by a set of possible keywords and their arguments, separated by spaces. /// The loc keyword defines the of the texture region as a rectangle whose origin is its top-left corner. It requires four arguments: x, y, width and height of the rectangle. /// The (optional) piv keyword defines the of the texture region. It requires two arguments: x and y. If it is not supplied, the pivot defaults to the top-left corner of the texture region. /// The (optional) off keyword defines an offset that is added onto the location and pivot of this texture region. This is useful when copying and pasting a previously defined texture region to create a second region that has a constant offset. It requires two arguments: The x and y offset. /// /// /// The following entry defines a texture region with the name LongTableRight, whose will be a rectangle with X=32, Y=30, Width=64, Height=48, and whose will be a vector with X=80, Y=46. /// /// LongTableRight /// loc 32 30 64 48 /// piv 80 46 /// /// /// /// /// To see a Data Texture Atlas in action, you can check out the sandbox project: https://github.com/Ellpeck/MLEM/blob/main/Sandbox/Content/Textures/Furniture.atlas. /// Additionally, if you are using Aseprite, there is a script to automatically populate it: https://github.com/Ellpeck/MLEM/blob/main/Utilities/Populate%20Data%20Texture%20Atlas.lua. /// public class DataTextureAtlas { /// /// The texture to use for this atlas /// public readonly TextureRegion Texture; /// /// Returns the texture region with the given name, or null if it does not exist. /// /// The region's name public TextureRegion this[string name] { get { this.regions.TryGetValue(name, out var ret); return ret; } } /// /// Returns an enumerable of all of the s in this atlas. /// public IEnumerable Regions => this.regions.Values; private readonly Dictionary regions = new Dictionary(); private DataTextureAtlas(TextureRegion texture) { this.Texture = texture; } /// /// Loads a from the given loaded texture and texture data file. /// /// The texture to use for this data texture atlas /// The content manager to use for loading /// The path, including extension, to the atlas info file /// If this value is true, then the pivot points passed in the info file will be relative to the coordinates of the texture region, not relative to the entire texture's origin. /// A new data texture atlas with the given settings public static DataTextureAtlas LoadAtlasData(TextureRegion texture, ContentManager content, string infoPath, bool pivotRelative = false) { var info = Path.Combine(content.RootDirectory, infoPath); string text; if (Path.IsPathRooted(info)) { text = File.ReadAllText(info); } else { using (var reader = new StreamReader(TitleContainer.OpenStream(info))) text = reader.ReadToEnd(); } var atlas = new DataTextureAtlas(texture); // parse each texture region: " loc [piv ] [off ]" foreach (Match match in Regex.Matches(text, @"(.+)\W+loc\W+([0-9]+)\W+([0-9]+)\W+([0-9]+)\W+([0-9]+)\W*(?:piv\W+([0-9.]+)\W+([0-9.]+))?\W*(?:off\W+([0-9.]+)\W+([0-9.]+))?")) { var name = match.Groups[1].Value.Trim(); // offset var off = !match.Groups[8].Success ? Vector2.Zero : new Vector2( float.Parse(match.Groups[8].Value, CultureInfo.InvariantCulture), float.Parse(match.Groups[9].Value, CultureInfo.InvariantCulture)); // location var loc = new Rectangle( int.Parse(match.Groups[2].Value), int.Parse(match.Groups[3].Value), int.Parse(match.Groups[4].Value), int.Parse(match.Groups[5].Value)); loc.Offset(off); // pivot var piv = !match.Groups[6].Success ? Vector2.Zero : off + new Vector2( float.Parse(match.Groups[6].Value, CultureInfo.InvariantCulture) - (pivotRelative ? 0 : loc.X), float.Parse(match.Groups[7].Value, CultureInfo.InvariantCulture) - (pivotRelative ? 0 : loc.Y)); var region = new TextureRegion(texture, loc) { PivotPixels = piv, Name = name }; atlas.regions.Add(name, region); } return atlas; } } /// /// A set of extension methods for dealing with . /// public static class DataTextureAtlasExtensions { /// /// Loads a from the given texture and texture data file. /// /// The content manager to use for loading /// The path to the texture file /// The path, including extension, to the atlas info file, or null if ".atlas" should be used /// If this value is true, then the pivot points passed in the info file will be relative to the coordinates of the texture region, not relative to the entire texture's origin. /// A new data texture atlas with the given settings public static DataTextureAtlas LoadTextureAtlas(this ContentManager content, string texturePath, string infoPath = null, bool pivotRelative = false) { var texture = new TextureRegion(content.Load(texturePath)); return DataTextureAtlas.LoadAtlasData(texture, content, infoPath ?? $"{texturePath}.atlas", pivotRelative); } } }