2019-01-24 08:43:03 +00:00
|
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2022-06-17 07:37:17 +00:00
|
|
|
|
#nullable disable
|
|
|
|
|
|
2019-05-14 04:04:49 +00:00
|
|
|
|
using System;
|
2022-04-07 08:26:31 +00:00
|
|
|
|
using System.IO;
|
2017-09-07 21:55:05 +00:00
|
|
|
|
using osu.Framework.Allocation;
|
2017-09-08 18:39:17 +00:00
|
|
|
|
using osu.Framework.Graphics;
|
2017-09-07 21:55:05 +00:00
|
|
|
|
using osu.Framework.Graphics.Animations;
|
|
|
|
|
using osu.Framework.Graphics.Textures;
|
2020-01-09 04:43:44 +00:00
|
|
|
|
using osu.Framework.Utils;
|
2022-09-23 11:10:57 +00:00
|
|
|
|
using osu.Game.Beatmaps;
|
2022-04-07 06:13:39 +00:00
|
|
|
|
using osu.Game.Skinning;
|
2020-10-23 06:33:38 +00:00
|
|
|
|
using osuTK;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2017-09-07 21:55:05 +00:00
|
|
|
|
namespace osu.Game.Storyboards.Drawables
|
|
|
|
|
{
|
2022-04-07 08:34:50 +00:00
|
|
|
|
public partial class DrawableStoryboardAnimation : TextureAnimation, IFlippable, IVectorScalable
|
2017-09-07 21:55:05 +00:00
|
|
|
|
{
|
2020-01-20 04:50:27 +00:00
|
|
|
|
public StoryboardAnimation Animation { get; }
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2019-12-18 08:27:13 +00:00
|
|
|
|
private bool flipH;
|
|
|
|
|
|
|
|
|
|
public bool FlipH
|
|
|
|
|
{
|
|
|
|
|
get => flipH;
|
|
|
|
|
set
|
|
|
|
|
{
|
|
|
|
|
if (flipH == value)
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
flipH = value;
|
|
|
|
|
Invalidate(Invalidation.MiscGeometry);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private bool flipV;
|
|
|
|
|
|
|
|
|
|
public bool FlipV
|
|
|
|
|
{
|
|
|
|
|
get => flipV;
|
|
|
|
|
set
|
|
|
|
|
{
|
|
|
|
|
if (flipV == value)
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
flipV = value;
|
|
|
|
|
Invalidate(Invalidation.MiscGeometry);
|
|
|
|
|
}
|
|
|
|
|
}
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2019-12-18 08:21:38 +00:00
|
|
|
|
private Vector2 vectorScale = Vector2.One;
|
|
|
|
|
|
|
|
|
|
public Vector2 VectorScale
|
|
|
|
|
{
|
|
|
|
|
get => vectorScale;
|
|
|
|
|
set
|
|
|
|
|
{
|
|
|
|
|
if (vectorScale == value)
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
if (!Validation.IsFinite(value)) throw new ArgumentException($@"{nameof(VectorScale)} must be finite, but is {value}.");
|
|
|
|
|
|
|
|
|
|
vectorScale = value;
|
|
|
|
|
Invalidate(Invalidation.MiscGeometry);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-03-03 16:48:00 +00:00
|
|
|
|
public override bool RemoveWhenNotAlive => false;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2022-03-14 03:29:49 +00:00
|
|
|
|
protected override Vector2 DrawScale
|
|
|
|
|
=> new Vector2(FlipH ? -base.DrawScale.X : base.DrawScale.X, FlipV ? -base.DrawScale.Y : base.DrawScale.Y) * VectorScale;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2022-03-14 02:44:34 +00:00
|
|
|
|
public override Anchor Origin => StoryboardExtensions.AdjustOrigin(base.Origin, VectorScale, FlipH, FlipV);
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2017-09-10 18:08:56 +00:00
|
|
|
|
public override bool IsPresent
|
|
|
|
|
=> !float.IsNaN(DrawPosition.X) && !float.IsNaN(DrawPosition.Y) && base.IsPresent;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2017-09-13 09:22:24 +00:00
|
|
|
|
public DrawableStoryboardAnimation(StoryboardAnimation animation)
|
2017-09-07 21:55:05 +00:00
|
|
|
|
{
|
2017-09-13 09:22:24 +00:00
|
|
|
|
Animation = animation;
|
|
|
|
|
Origin = animation.Origin;
|
|
|
|
|
Position = animation.InitialPosition;
|
2020-10-19 20:27:59 +00:00
|
|
|
|
Loop = animation.LoopType == AnimationLoopType.LoopForever;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2017-09-15 11:35:41 +00:00
|
|
|
|
LifetimeStart = animation.StartTime;
|
2023-04-26 04:28:51 +00:00
|
|
|
|
LifetimeEnd = animation.EndTimeForDisplay;
|
2017-09-07 21:55:05 +00:00
|
|
|
|
}
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2022-04-07 08:26:31 +00:00
|
|
|
|
[Resolved]
|
|
|
|
|
private ISkinSource skin { get; set; }
|
|
|
|
|
|
2022-09-23 11:10:57 +00:00
|
|
|
|
[Resolved]
|
|
|
|
|
private IBeatSyncProvider beatSyncProvider { get; set; }
|
|
|
|
|
|
2023-09-20 03:54:36 +00:00
|
|
|
|
[Resolved]
|
|
|
|
|
private TextureStore textureStore { get; set; }
|
|
|
|
|
|
2017-09-07 21:55:05 +00:00
|
|
|
|
[BackgroundDependencyLoader]
|
2023-09-20 03:54:36 +00:00
|
|
|
|
private void load(Storyboard storyboard)
|
2017-09-07 21:55:05 +00:00
|
|
|
|
{
|
2023-09-20 03:54:36 +00:00
|
|
|
|
if (storyboard.UseSkinSprites)
|
2017-09-07 21:55:05 +00:00
|
|
|
|
{
|
2022-04-07 08:26:31 +00:00
|
|
|
|
skin.SourceChanged += skinSourceChanged;
|
|
|
|
|
skinSourceChanged();
|
2017-09-07 21:55:05 +00:00
|
|
|
|
}
|
2023-09-20 03:54:36 +00:00
|
|
|
|
else
|
|
|
|
|
addFramesFromStoryboardSource();
|
2019-02-28 04:31:40 +00:00
|
|
|
|
|
2017-09-13 09:22:24 +00:00
|
|
|
|
Animation.ApplyTransforms(this);
|
2017-09-07 21:55:05 +00:00
|
|
|
|
}
|
2022-04-07 08:26:31 +00:00
|
|
|
|
|
2022-09-12 05:05:16 +00:00
|
|
|
|
protected override void LoadComplete()
|
|
|
|
|
{
|
|
|
|
|
base.LoadComplete();
|
|
|
|
|
|
|
|
|
|
// Framework animation class tries its best to synchronise the animation at LoadComplete,
|
|
|
|
|
// but in some cases (such as fast forward) this results in an incorrect start offset.
|
|
|
|
|
//
|
|
|
|
|
// In the case of storyboard animations, we want to synchronise with game time perfectly
|
|
|
|
|
// so let's get a correct time based on gameplay clock and earliest transform.
|
2023-07-13 13:12:55 +00:00
|
|
|
|
PlaybackPosition = beatSyncProvider.Clock.CurrentTime - Animation.EarliestTransformTime;
|
2022-09-12 05:05:16 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-04-07 08:26:31 +00:00
|
|
|
|
private void skinSourceChanged()
|
|
|
|
|
{
|
|
|
|
|
ClearFrames();
|
|
|
|
|
|
|
|
|
|
// When reading from a skin, we match stables weird behaviour where `FrameCount` is ignored
|
|
|
|
|
// and resources are retrieved until the end of the animation.
|
2024-01-17 13:38:36 +00:00
|
|
|
|
var skinTextures = skin.GetTextures(Path.ChangeExtension(Animation.Path, null), default, default, true, string.Empty, null, out _);
|
2023-09-20 03:54:36 +00:00
|
|
|
|
|
|
|
|
|
if (skinTextures.Length > 0)
|
|
|
|
|
{
|
|
|
|
|
foreach (var texture in skinTextures)
|
|
|
|
|
AddFrame(texture, Animation.FrameDelay);
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
addFramesFromStoryboardSource();
|
|
|
|
|
}
|
2022-04-07 08:26:31 +00:00
|
|
|
|
}
|
|
|
|
|
|
2023-09-20 03:54:36 +00:00
|
|
|
|
private void addFramesFromStoryboardSource()
|
|
|
|
|
{
|
|
|
|
|
int frameIndex;
|
|
|
|
|
// sourcing from storyboard.
|
|
|
|
|
for (frameIndex = 0; frameIndex < Animation.FrameCount; frameIndex++)
|
|
|
|
|
AddFrame(textureStore.Get(getFramePath(frameIndex)), Animation.FrameDelay);
|
|
|
|
|
|
|
|
|
|
string getFramePath(int i) => Animation.Path.Replace(".", $"{i}.");
|
|
|
|
|
}
|
2022-04-07 08:26:31 +00:00
|
|
|
|
|
|
|
|
|
protected override void Dispose(bool isDisposing)
|
|
|
|
|
{
|
|
|
|
|
base.Dispose(isDisposing);
|
2022-04-07 19:37:42 +00:00
|
|
|
|
|
|
|
|
|
if (skin != null)
|
|
|
|
|
skin.SourceChanged -= skinSourceChanged;
|
2022-04-07 08:26:31 +00:00
|
|
|
|
}
|
2017-09-07 21:55:05 +00:00
|
|
|
|
}
|
|
|
|
|
}
|