(61d00a474) v0.9.7.1
This commit is contained in:
Regalis
@@ -0,0 +1,345 @@
|
||||
using Microsoft.Xna.Framework;
|
||||
using System.Collections.Generic;
|
||||
using System.Xml.Linq;
|
||||
using System.Linq;
|
||||
using Barotrauma.Extensions;
|
||||
using System.IO;
|
||||
using System;
|
||||
using SpriteParams = Barotrauma.RagdollParams.SpriteParams;
|
||||
#if CLIENT
|
||||
using Microsoft.Xna.Framework.Graphics;
|
||||
#endif
|
||||
|
||||
namespace Barotrauma
|
||||
{
|
||||
public partial class Sprite
|
||||
{
|
||||
public static IEnumerable<Sprite> LoadedSprites
|
||||
{
|
||||
get
|
||||
{
|
||||
List<Sprite> retVal = null;
|
||||
lock (list)
|
||||
{
|
||||
retVal = list.Select(wRef =>
|
||||
{
|
||||
if (wRef.TryGetTarget(out Sprite spr))
|
||||
{
|
||||
return spr;
|
||||
}
|
||||
return null;
|
||||
}).Where(s => s!=null).ToList();
|
||||
}
|
||||
return retVal;
|
||||
}
|
||||
}
|
||||
|
||||
private static List<WeakReference<Sprite>> list = new List<WeakReference<Sprite>>();
|
||||
|
||||
/// <summary>
|
||||
/// Reference to the xml element from where the sprite was created. Can be null if the sprite was not defined in xml!
|
||||
/// </summary>
|
||||
public XElement SourceElement { get; private set; }
|
||||
|
||||
//the area in the texture that is supposed to be drawn
|
||||
private Rectangle sourceRect;
|
||||
|
||||
//the offset used when drawing the sprite
|
||||
protected Vector2 offset;
|
||||
|
||||
private bool lazyLoad;
|
||||
|
||||
protected Vector2 origin;
|
||||
|
||||
//the size of the drawn sprite, if larger than the source,
|
||||
//the sprite is tiled to fill the target size
|
||||
public Vector2 size = Vector2.One;
|
||||
|
||||
public float rotation;
|
||||
|
||||
#if CLIENT
|
||||
public SpriteEffects effects = SpriteEffects.None;
|
||||
#endif
|
||||
|
||||
protected float depth;
|
||||
|
||||
public Rectangle SourceRect
|
||||
{
|
||||
get { return sourceRect; }
|
||||
set { sourceRect = value; }
|
||||
}
|
||||
|
||||
public float Depth
|
||||
{
|
||||
get { return depth; }
|
||||
set { depth = MathHelper.Clamp(value, 0.001f, 0.999f); }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// In pixels
|
||||
/// </summary>
|
||||
public Vector2 Origin
|
||||
{
|
||||
get { return origin; }
|
||||
set
|
||||
{
|
||||
origin = value;
|
||||
_relativeOrigin = new Vector2(origin.X / sourceRect.Width, origin.Y / sourceRect.Height);
|
||||
}
|
||||
}
|
||||
|
||||
private Vector2 _relativeOrigin;
|
||||
/// <summary>
|
||||
/// 0 - 1
|
||||
/// </summary>
|
||||
public Vector2 RelativeOrigin
|
||||
{
|
||||
get => _relativeOrigin;
|
||||
set
|
||||
{
|
||||
_relativeOrigin = value;
|
||||
origin = new Vector2(_relativeOrigin.X * sourceRect.Width, _relativeOrigin.Y * sourceRect.Height);
|
||||
}
|
||||
}
|
||||
|
||||
public Vector2 RelativeSize { get; private set; }
|
||||
|
||||
public string FilePath { get; private set; }
|
||||
|
||||
public string FullPath { get; private set; }
|
||||
|
||||
public override string ToString()
|
||||
{
|
||||
return FilePath + ": " + sourceRect;
|
||||
}
|
||||
|
||||
public string ID { get; private set; }
|
||||
/// <summary>
|
||||
/// ID of the Map Entity so that we can link the sprite to it's owner.
|
||||
/// </summary>
|
||||
public string EntityID { get; set; }
|
||||
public string Name { get; set; }
|
||||
|
||||
partial void LoadTexture(ref Vector4 sourceVector, ref bool shouldReturn);
|
||||
|
||||
partial void CalculateSourceRect();
|
||||
|
||||
private static void AddToList(Sprite elem)
|
||||
{
|
||||
lock (list)
|
||||
{
|
||||
list.Add(new WeakReference<Sprite>(elem));
|
||||
}
|
||||
}
|
||||
|
||||
public Sprite(XElement element, string path = "", string file = "", bool lazyLoad = false)
|
||||
{
|
||||
if (element == null) { return; }
|
||||
this.lazyLoad = lazyLoad;
|
||||
SourceElement = element;
|
||||
if (!ParseTexturePath(path, file)) { return; }
|
||||
Name = SourceElement.GetAttributeString("name", null);
|
||||
Vector4 sourceVector = SourceElement.GetAttributeVector4("sourcerect", Vector4.Zero);
|
||||
var overrideElement = GetLocalizationOverrideElement();
|
||||
if (overrideElement != null && overrideElement.Attribute("sourcerect") != null)
|
||||
{
|
||||
sourceVector = overrideElement.GetAttributeVector4("sourcerect", Vector4.Zero);
|
||||
}
|
||||
bool shouldReturn = false;
|
||||
if (!lazyLoad)
|
||||
{
|
||||
LoadTexture(ref sourceVector, ref shouldReturn);
|
||||
}
|
||||
if (shouldReturn) { return; }
|
||||
sourceRect = new Rectangle((int)sourceVector.X, (int)sourceVector.Y, (int)sourceVector.Z, (int)sourceVector.W);
|
||||
size = SourceElement.GetAttributeVector2("size", Vector2.One);
|
||||
RelativeSize = size;
|
||||
size.X *= sourceRect.Width;
|
||||
size.Y *= sourceRect.Height;
|
||||
RelativeOrigin = SourceElement.GetAttributeVector2("origin", new Vector2(0.5f, 0.5f));
|
||||
Depth = SourceElement.GetAttributeFloat("depth", 0.001f);
|
||||
ID = GetID(SourceElement);
|
||||
AddToList(this);
|
||||
}
|
||||
|
||||
internal void LoadParams(SpriteParams spriteParams, bool isFlipped)
|
||||
{
|
||||
SourceElement = spriteParams.Element;
|
||||
sourceRect = spriteParams.SourceRect;
|
||||
RelativeOrigin = spriteParams.Origin;
|
||||
if (isFlipped)
|
||||
{
|
||||
Origin = new Vector2(sourceRect.Width - origin.X, origin.Y);
|
||||
}
|
||||
depth = spriteParams.Depth;
|
||||
}
|
||||
|
||||
public Sprite(string newFile, Vector2 newOrigin)
|
||||
{
|
||||
Init(newFile, newOrigin: newOrigin);
|
||||
AddToList(this);
|
||||
}
|
||||
|
||||
public Sprite(string newFile, Rectangle? sourceRectangle, Vector2? origin = null, float rotation = 0)
|
||||
{
|
||||
Init(newFile, sourceRectangle: sourceRectangle, newOrigin: origin, newRotation: rotation);
|
||||
AddToList(this);
|
||||
}
|
||||
|
||||
private void Init(string newFile, Rectangle? sourceRectangle = null, Vector2? newOrigin = null, Vector2? newOffset = null, float newRotation = 0)
|
||||
{
|
||||
FilePath = newFile;
|
||||
if (!string.IsNullOrEmpty(FilePath))
|
||||
{
|
||||
FullPath = Path.GetFullPath(FilePath);
|
||||
}
|
||||
Vector4 sourceVector = Vector4.Zero;
|
||||
bool shouldReturn = false;
|
||||
LoadTexture(ref sourceVector, ref shouldReturn);
|
||||
if (shouldReturn) return;
|
||||
if (sourceRectangle.HasValue)
|
||||
{
|
||||
sourceRect = sourceRectangle.Value;
|
||||
}
|
||||
else
|
||||
{
|
||||
CalculateSourceRect();
|
||||
}
|
||||
offset = newOffset ?? Vector2.Zero;
|
||||
if (newOrigin.HasValue)
|
||||
{
|
||||
RelativeOrigin = newOrigin.Value;
|
||||
}
|
||||
size = new Vector2(sourceRect.Width, sourceRect.Height);
|
||||
rotation = newRotation;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a supposedly unique id from the parent element. If the parent element is not found, uses the sprite element.
|
||||
/// TODO: If there are multiple elements with exactly the same data, the ids will fail. -> Is there a better way to identify the sprites?
|
||||
/// </summary>
|
||||
public static string GetID(XElement sourceElement)
|
||||
{
|
||||
if (sourceElement == null) { return string.Empty; }
|
||||
var parentElement = sourceElement.Parent;
|
||||
return parentElement != null ? sourceElement.ToString() + parentElement.ToString() : sourceElement.ToString();
|
||||
}
|
||||
|
||||
public void Remove()
|
||||
{
|
||||
lock (list)
|
||||
{
|
||||
list.RemoveAll(wRef => !wRef.TryGetTarget(out Sprite s) || s==this);
|
||||
}
|
||||
DisposeTexture();
|
||||
}
|
||||
|
||||
~Sprite()
|
||||
{
|
||||
Remove();
|
||||
}
|
||||
|
||||
partial void DisposeTexture();
|
||||
|
||||
/// <summary>
|
||||
/// Works only if there is a name attribute defined for the sprite. For items and structures, the entity id or name is used if the sprite's name attribute is not defined.
|
||||
/// </summary>
|
||||
public void ReloadXML()
|
||||
{
|
||||
if (SourceElement == null) { return; }
|
||||
string path = SourceElement.ParseContentPathFromUri();
|
||||
if (string.IsNullOrWhiteSpace(path))
|
||||
{
|
||||
DebugConsole.NewMessage($"[Sprite] Could not parse the content path from the source element ({SourceElement}) uri: {SourceElement.BaseUri}", Color.Yellow);
|
||||
return;
|
||||
}
|
||||
var doc = XMLExtensions.TryLoadXml(path);
|
||||
if (doc == null) { return; }
|
||||
if (string.IsNullOrWhiteSpace(Name) && string.IsNullOrWhiteSpace(EntityID)) { return; }
|
||||
var spriteElements = doc.Descendants("sprite").Concat(doc.Descendants("Sprite"));
|
||||
var sourceElements = spriteElements.Where(e => e.GetAttributeString("name", null) == Name);
|
||||
if (sourceElements.None())
|
||||
{
|
||||
// Try parents by first comparing the entity id and then the name, if no match was found.
|
||||
sourceElements = spriteElements.Where(e => e.Parent?.GetAttributeString("identifier", null) == EntityID);
|
||||
if (sourceElements.None())
|
||||
{
|
||||
sourceElements = spriteElements.Where(e => e.Parent?.GetAttributeString("name", null) == Name);
|
||||
}
|
||||
}
|
||||
if (sourceElements.Multiple())
|
||||
{
|
||||
DebugConsole.NewMessage($"[Sprite] Multiple matching elements found by name ({Name}) or identifier ({EntityID})!: {SourceElement.ToString()}", Color.Yellow);
|
||||
}
|
||||
else if (sourceElements.None())
|
||||
{
|
||||
DebugConsole.NewMessage($"[Sprite] Cannot find matching source element by comparing the name attribute ({Name}) or identifier ({EntityID})! Cannot reload the xml for sprite element \"{SourceElement.ToString()}\"!", Color.Yellow);
|
||||
}
|
||||
else
|
||||
{
|
||||
SourceElement = sourceElements.Single();
|
||||
}
|
||||
if (SourceElement != null)
|
||||
{
|
||||
sourceRect = SourceElement.GetAttributeRect("sourcerect", Rectangle.Empty);
|
||||
var overrideElement = GetLocalizationOverrideElement();
|
||||
if (overrideElement != null && overrideElement.Attribute("sourcerect") != null)
|
||||
{
|
||||
sourceRect = overrideElement.GetAttributeRect("sourcerect", Rectangle.Empty);
|
||||
}
|
||||
size = SourceElement.GetAttributeVector2("size", Vector2.One);
|
||||
size.X *= sourceRect.Width;
|
||||
size.Y *= sourceRect.Height;
|
||||
RelativeOrigin = SourceElement.GetAttributeVector2("origin", new Vector2(0.5f, 0.5f));
|
||||
Depth = SourceElement.GetAttributeFloat("depth", 0.001f);
|
||||
ID = GetID(SourceElement);
|
||||
}
|
||||
}
|
||||
|
||||
public bool ParseTexturePath(string path = "", string file = "")
|
||||
{
|
||||
if (file == "")
|
||||
{
|
||||
file = SourceElement.GetAttributeString("texture", "");
|
||||
var overrideElement = GetLocalizationOverrideElement();
|
||||
if (overrideElement != null)
|
||||
{
|
||||
string overrideFile = overrideElement.GetAttributeString("texture", "");
|
||||
if (!string.IsNullOrEmpty(overrideFile)) { file = overrideFile; }
|
||||
}
|
||||
}
|
||||
if (file == "")
|
||||
{
|
||||
DebugConsole.ThrowError("Sprite " + SourceElement + " doesn't have a texture specified!");
|
||||
return false;
|
||||
}
|
||||
if (!string.IsNullOrEmpty(path))
|
||||
{
|
||||
if (!path.EndsWith("/")) path += "/";
|
||||
}
|
||||
FilePath = path + file;
|
||||
if (!string.IsNullOrEmpty(FilePath))
|
||||
{
|
||||
FullPath = Path.GetFullPath(FilePath);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
private XElement GetLocalizationOverrideElement()
|
||||
{
|
||||
foreach (XElement subElement in SourceElement.Elements())
|
||||
{
|
||||
if (subElement.Name.ToString().Equals("override", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
string language = subElement.GetAttributeString("language", "");
|
||||
if (TextManager.Language.Equals(language, StringComparison.InvariantCultureIgnoreCase))
|
||||
{
|
||||
return subElement;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user