#region Copyright & License Information /* * Copyright 2007-2015 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. For more information, * see COPYING. */ #endregion using System; using System.Collections.Generic; using System.IO; using System.Linq; using OpenRA.Graphics; namespace OpenRA.Mods.Common.Graphics { public class DefaultSpriteSequenceLoader : ISpriteSequenceLoader { public DefaultSpriteSequenceLoader(ModData modData) { } public virtual ISpriteSequence CreateSequence(ModData modData, TileSet tileSet, SpriteCache cache, string sequence, string animation, MiniYaml info) { return new DefaultSpriteSequence(modData, tileSet, cache, this, sequence, animation, info); } public IReadOnlyDictionary ParseSequences(ModData modData, TileSet tileSet, SpriteCache cache, MiniYamlNode node) { var sequences = new Dictionary(); foreach (var kvp in node.Value.ToDictionary()) { using (new Support.PerfTimer("new Sequence(\"{0}\")".F(node.Key), 20)) { try { sequences.Add(kvp.Key, CreateSequence(modData, tileSet, cache, node.Key, kvp.Key, kvp.Value)); } catch (FileNotFoundException ex) { // Eat the FileNotFound exceptions from missing sprites Log.Write("debug", ex.Message); } } } return new ReadOnlyDictionary(sequences); } } public class DefaultSpriteSequence : ISpriteSequence { readonly Sprite[] sprites; readonly bool reverseFacings, transpose; protected readonly ISpriteSequenceLoader Loader; public string Name { get; private set; } public int Start { get; private set; } public int Length { get; private set; } public int Stride { get; private set; } public int Facings { get; private set; } public int Tick { get; private set; } public int ZOffset { get; private set; } public int ShadowStart { get; private set; } public int ShadowZOffset { get; private set; } public int[] Frames { get; private set; } protected virtual string GetSpriteSrc(ModData modData, TileSet tileSet, string sequence, string animation, MiniYaml info, Dictionary d) { return info.Value ?? sequence; } public DefaultSpriteSequence(ModData modData, TileSet tileSet, SpriteCache cache, ISpriteSequenceLoader loader, string sequence, string animation, MiniYaml info) { Name = animation; Loader = loader; var d = info.ToDictionary(); var offset = float2.Zero; var blendMode = BlendMode.Alpha; try { if (d.ContainsKey("Start")) Start = Exts.ParseIntegerInvariant(d["Start"].Value); if (d.ContainsKey("Offset")) offset = FieldLoader.GetValue("Offset", d["Offset"].Value); if (d.ContainsKey("BlendMode")) blendMode = FieldLoader.GetValue("BlendMode", d["BlendMode"].Value); // Apply offset to each sprite in the sequence // Different sequences may apply different offsets to the same frame var src = GetSpriteSrc(modData, tileSet, sequence, animation, info, d); sprites = cache[src].Select( s => new Sprite(s.Sheet, s.Bounds, s.Offset + offset, s.Channel, blendMode)).ToArray(); if (!d.ContainsKey("Length")) Length = 1; else if (d["Length"].Value == "*") Length = sprites.Length - Start; else Length = Exts.ParseIntegerInvariant(d["Length"].Value); if (d.ContainsKey("Stride")) Stride = Exts.ParseIntegerInvariant(d["Stride"].Value); else Stride = Length; if (d.ContainsKey("Facings")) { var f = Exts.ParseIntegerInvariant(d["Facings"].Value); Facings = Math.Abs(f); reverseFacings = f < 0; } else Facings = 1; if (d.ContainsKey("Tick")) Tick = Exts.ParseIntegerInvariant(d["Tick"].Value); else Tick = 40; if (d.ContainsKey("Transpose")) transpose = bool.Parse(d["Transpose"].Value); if (d.ContainsKey("Frames")) Frames = Array.ConvertAll(d["Frames"].Value.Split(','), Exts.ParseIntegerInvariant); if (d.ContainsKey("ShadowStart")) ShadowStart = Exts.ParseIntegerInvariant(d["ShadowStart"].Value); else ShadowStart = -1; if (d.ContainsKey("ShadowZOffset")) { WRange r; if (WRange.TryParse(d["ShadowZOffset"].Value, out r)) ShadowZOffset = r.Range; } else ShadowZOffset = -5; if (d.ContainsKey("ZOffset")) { WRange r; if (WRange.TryParse(d["ZOffset"].Value, out r)) ZOffset = r.Range; } if (Length > Stride) throw new InvalidOperationException( "{0}: Sequence {1}.{2}: Length must be <= stride" .F(info.Nodes[0].Location, sequence, animation)); if (Start < 0 || Start + Facings * Stride > sprites.Length || ShadowStart + Facings * Stride > sprites.Length) throw new InvalidOperationException( "{6}: Sequence {0}.{1} uses frames [{2}..{3}] of SHP `{4}`, but only 0..{5} actually exist" .F(sequence, animation, Start, Start + Facings * Stride - 1, src, sprites.Length - 1, info.Nodes[0].Location)); } catch (FormatException f) { throw new FormatException("Failed to parse sequences for {0}.{1} at {2}:\n{3}".F(sequence, animation, info.Nodes[0].Location, f)); } } public Sprite GetSprite(int frame) { return GetSprite(Start, frame, 0); } public Sprite GetSprite(int frame, int facing) { return GetSprite(Start, frame, facing); } public Sprite GetShadow(int frame, int facing) { return ShadowStart >= 0 ? GetSprite(ShadowStart, frame, facing) : null; } protected virtual Sprite GetSprite(int start, int frame, int facing) { var f = OpenRA.Traits.Util.QuantizeFacing(facing, Facings); if (reverseFacings) f = (Facings - f) % Facings; var i = transpose ? (frame % Length) * Facings + f : (f * Stride) + (frame % Length); if (Frames != null) return sprites[Frames[i]]; return sprites[start + i]; } } }