From eb61c45e14861c10dddd52f22f816edd1251d46a Mon Sep 17 00:00:00 2001 From: Paul Chote Date: Sun, 7 Oct 2018 17:40:05 +0000 Subject: [PATCH] Add EmbeddedSpritePalette sprite metadata. --- .../Graphics/DefaultSpriteSequence.cs | 34 ++++++++++ OpenRA.Mods.Common/OpenRA.Mods.Common.csproj | 1 + .../SpriteLoaders/PngSheetLoader.cs | 6 ++ .../World/PaletteFromEmbeddedSpritePalette.cs | 65 +++++++++++++++++++ 4 files changed, 106 insertions(+) create mode 100644 OpenRA.Mods.Common/Traits/World/PaletteFromEmbeddedSpritePalette.cs diff --git a/OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs b/OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs index 37ff76c14e..2d36ab540a 100644 --- a/OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs +++ b/OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs @@ -18,6 +18,26 @@ using OpenRA.Graphics; namespace OpenRA.Mods.Common.Graphics { + public class EmbeddedSpritePalette + { + readonly uint[] filePalette = null; + readonly Dictionary framePalettes = null; + + public EmbeddedSpritePalette(uint[] filePalette = null, Dictionary framePalettes = null) + { + this.filePalette = filePalette; + this.framePalettes = framePalettes; + } + + public bool TryGetPaletteForFrame(int frame, out uint[] palette) + { + if (framePalettes == null || !framePalettes.TryGetValue(frame, out palette)) + palette = filePalette; + + return palette != null; + } + } + public class DefaultSpriteSequenceLoader : ISpriteSequenceLoader { public Action OnMissingSpriteError { get; set; } @@ -93,6 +113,8 @@ namespace OpenRA.Mods.Common.Graphics public int[] Frames { get; private set; } public Rectangle Bounds { get; private set; } + public readonly uint[] EmbeddedPalette; + protected virtual string GetSpriteSrc(ModData modData, TileSet tileSet, string sequence, string animation, string sprite, Dictionary d) { return sprite ?? sequence; @@ -286,6 +308,18 @@ namespace OpenRA.Mods.Common.Graphics }).ToArray(); } + var exportPalette = LoadField(d, "EmbeddedPalette", null); + if (exportPalette != null) + { + var src = GetSpriteSrc(modData, tileSet, sequence, animation, info.Value, d); + + var metadata = cache.FrameMetadata(src); + var i = Frames != null ? Frames[0] : Start; + var palettes = metadata != null ? metadata.GetOrDefault() : null; + if (palettes == null || !palettes.TryGetPaletteForFrame(i, out EmbeddedPalette)) + throw new YamlException("Cannot export palettes from {0}: frame {1} does not define an embedded palette".F(src, i)); + } + var boundSprites = SpriteBounds(sprites, Frames, Start, Facings, Length, Stride, transpose); if (ShadowStart > 0) boundSprites = boundSprites.Concat(SpriteBounds(sprites, Frames, ShadowStart, Facings, Length, Stride, transpose)); diff --git a/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj b/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj index caa07b1396..ae18e962f3 100644 --- a/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj +++ b/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj @@ -555,6 +555,7 @@ + diff --git a/OpenRA.Mods.Common/SpriteLoaders/PngSheetLoader.cs b/OpenRA.Mods.Common/SpriteLoaders/PngSheetLoader.cs index f13eaa941f..4785ffe06f 100644 --- a/OpenRA.Mods.Common/SpriteLoaders/PngSheetLoader.cs +++ b/OpenRA.Mods.Common/SpriteLoaders/PngSheetLoader.cs @@ -16,6 +16,7 @@ using System.IO; using System.Linq; using OpenRA.FileFormats; using OpenRA.Graphics; +using OpenRA.Mods.Common.Graphics; using OpenRA.Primitives; namespace OpenRA.Mods.Common.SpriteLoaders @@ -68,6 +69,11 @@ namespace OpenRA.Mods.Common.SpriteLoaders Array.Copy(png.Data, frameStart + y * png.Width, frames[i].Data, y * frames[i].Size.Width, frames[i].Size.Width); } + metadata = new TypeDictionary + { + new EmbeddedSpritePalette(png.Palette.Select(x => (uint)x.ToArgb()).ToArray()) + }; + return true; } diff --git a/OpenRA.Mods.Common/Traits/World/PaletteFromEmbeddedSpritePalette.cs b/OpenRA.Mods.Common/Traits/World/PaletteFromEmbeddedSpritePalette.cs new file mode 100644 index 0000000000..759a88bbbd --- /dev/null +++ b/OpenRA.Mods.Common/Traits/World/PaletteFromEmbeddedSpritePalette.cs @@ -0,0 +1,65 @@ +#region Copyright & License Information +/* + * Copyright 2007-2018 The OpenRA Developers (see AUTHORS) + * This file is part of OpenRA, which is free software. It is made + * available to you under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. For more + * information, see COPYING. + */ +#endregion + +using System.Collections.Generic; +using System.Linq; +using OpenRA.FileSystem; +using OpenRA.Graphics; +using OpenRA.Mods.Common.Graphics; +using OpenRA.Traits; + +namespace OpenRA.Mods.Common.Traits +{ + public class PaletteFromEmbeddedSpritePaletteInfo : ITraitInfo, IProvidesCursorPaletteInfo + { + [FieldLoader.Require, PaletteDefinition] + [Desc("Internal palette name")] + public readonly string Name = null; + + [FieldLoader.Require] + [Desc("Sequence image holding the palette definition")] + public readonly string Image = null; + + [FieldLoader.Require] + [Desc("Sequence holding the palette definition")] + public readonly string Sequence = null; + + [Desc("Allow palette modifiers to change the palette.")] + public readonly bool AllowModifiers = true; + + [Desc("Whether this palette is available for cursors.")] + public readonly bool CursorPalette = false; + + public object Create(ActorInitializer init) { return new PaletteFromEmbeddedSpritePalette(this); } + + string IProvidesCursorPaletteInfo.Palette { get { return CursorPalette ? Name : null; } } + + ImmutablePalette IProvidesCursorPaletteInfo.ReadPalette(IReadOnlyFileSystem fileSystem) + { + var sequence = (DefaultSpriteSequence)Game.ModData.DefaultSequences.Values.First().GetSequence(Image, Sequence); + return new ImmutablePalette(sequence.EmbeddedPalette); + } + } + + public class PaletteFromEmbeddedSpritePalette : ILoadsPalettes, IProvidesAssetBrowserPalettes + { + readonly PaletteFromEmbeddedSpritePaletteInfo info; + public PaletteFromEmbeddedSpritePalette(PaletteFromEmbeddedSpritePaletteInfo info) { this.info = info; } + + public void LoadPalettes(WorldRenderer wr) + { + var sequence = (DefaultSpriteSequence)wr.World.Map.Rules.Sequences.GetSequence(info.Image, info.Sequence); + wr.AddPalette(info.Name, new ImmutablePalette(sequence.EmbeddedPalette), info.AllowModifiers); + } + + public IEnumerable PaletteNames { get { yield return info.Name; } } + } +}