/// <summary>
/// Loads the specified sprite animation.
/// </summary>
/// <remarks>Content managers maintain a cache of references to all loaded assets, so calling <see cref="ContentManager.Load{T}(String, Boolean)"/> multiple
/// times on a content manager with the same parameter will return the same object rather than reloading the source file.</remarks>
/// <param name="contentManager">The <see cref="ContentManager"/> with which to load the animation's associated sprite asset.</param>
/// <param name="id">The identifier that represents the sprite animation to load.</param>
/// <param name="cache">A value indicating whether to add the sprite asset to the manager's cache.</param>
/// <returns>The sprite animation that was loaded.</returns>
public static SpriteAnimation Load(this ContentManager contentManager, SpriteAnimationID id, Boolean cache = true)
{
Contract.Require(contentManager, nameof(contentManager));
Contract.Ensure <ArgumentException>(id.IsValid, nameof(id));
Contract.EnsureNotDisposed(contentManager, contentManager.Disposed);
var sprite = contentManager.Load <Sprite>(SpriteAnimationID.GetSpriteAssetIDRef(ref id), cache);
var name = SpriteAnimationID.GetAnimationNameRef(ref id);
if (!String.IsNullOrEmpty(name))
{
var value = sprite[name];
if (value == null)
{
throw new ArgumentException(UltravioletStrings.InvalidSpriteAnimationReference.Format(id));
}
return(value);
}
var index = SpriteAnimationID.GetAnimationIndexRef(ref id);
if (index < 0 || index >= sprite.AnimationCount)
{
throw new ArgumentException(UltravioletStrings.InvalidSpriteAnimationReference.Format(id));
}
return(sprite[index]);
}
/// <summary>
/// Writes a sprite animation identifier to the stream.
/// </summary>
/// <param name="writer">The <see cref="BinaryWriter"/> with which to write the sprite animation identifier.</param>
/// <param name="id">The <see cref="SpriteAnimationID"/> to write to the stream.</param>
public static void Write(this BinaryWriter writer, SpriteAnimationID id)
{
writer.Write(id.IsValid);
if (id.IsValid)
{
writer.Write(SpriteAnimationID.GetSpriteAssetIDRef(ref id));
writer.Write(SpriteAnimationID.GetAnimationNameRef(ref id));
writer.Write(SpriteAnimationID.GetAnimationIndexRef(ref id));
}
}