LibWeb: Add the AnimationEffect IDL object

2025-07-27 08:27:46 +00:00 · 2023-11-06 15:17:15 +00:00 · 2023-11-06 15:17:15 +00:00 · 0df06ce273
commit 0df06ce273
parent e03e710d1b
7 changed files with 336 additions and 1 deletions
--- a/Userland/Libraries/LibWeb/Animations/AnimationEffect.h
+++ b/Userland/Libraries/LibWeb/Animations/AnimationEffect.h
@ -0,0 +1,117 @@
+/*
+ * Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/Optional.h>
+#include <AK/String.h>
+#include <AK/Variant.h>
+#include <LibWeb/Bindings/AnimationEffectPrototype.h>
+#include <LibWeb/Bindings/PlatformObject.h>
+
+namespace Web::Animations {
+
+// // https://www.w3.org/TR/web-animations-1/#the-effecttiming-dictionaries
+struct OptionalEffectTiming {
+    Optional<double> delay {};
+    Optional<double> end_delay {};
+    Optional<Bindings::FillMode> fill {};
+    Optional<double> iteration_start {};
+    Optional<double> iterations {};
+    Optional<Variant<double, String>> duration;
+    Optional<Bindings::PlaybackDirection> direction {};
+    Optional<String> easing {};
+};
+
+// // https://www.w3.org/TR/web-animations-1/#the-effecttiming-dictionaries
+struct EffectTiming {
+    double delay { 0 };
+    double end_delay { 0 };
+    Bindings::FillMode fill { Bindings::FillMode::Auto };
+    double iteration_start { 0.0 };
+    double iterations { 1.0 };
+    Variant<double, String> duration { "auto"_string };
+    Bindings::PlaybackDirection direction { Bindings::PlaybackDirection::Normal };
+    String easing { "linear"_string };
+
+    OptionalEffectTiming to_optional_effect_timing() const;
+};
+
+// https://www.w3.org/TR/web-animations-1/#the-computedeffecttiming-dictionary
+struct ComputedEffectTiming : public EffectTiming {
+    double end_time;
+    double active_duration;
+    Optional<double> local_time;
+    Optional<double> progress;
+    Optional<double> current_iteration;
+};
+
+// https://www.w3.org/TR/web-animations-1/#the-animationeffect-interface
+class AnimationEffect : public Bindings::PlatformObject {
+    WEB_PLATFORM_OBJECT(AnimationEffect, Bindings::PlatformObject);
+
+public:
+    static JS::NonnullGCPtr<AnimationEffect> create(JS::Realm&);
+
+    EffectTiming get_timing() const;
+    ComputedEffectTiming get_computed_timing() const;
+    WebIDL::ExceptionOr<void> update_timing(OptionalEffectTiming timing = {});
+
+    double start_delay() const { return m_start_delay; }
+    void set_start_delay(double start_delay) { m_start_delay = start_delay; }
+
+    double end_delay() const { return m_end_delay; }
+    void set_end_delay(double end_delay) { m_end_delay = end_delay; }
+
+    Bindings::FillMode fill_mode() const { return m_fill_mode; }
+    void set_fill_mode(Bindings::FillMode fill_mode) { m_fill_mode = fill_mode; }
+
+    double iteration_start() const { return m_iteration_start; }
+    void set_iteration_start(double iteration_start) { m_iteration_start = iteration_start; }
+
+    double iteration_count() const { return m_iteration_count; }
+    void set_iteration_count(double iteration_count) { m_iteration_count = iteration_count; }
+
+    Variant<double, String> const& iteration_duration() const { return m_iteration_duration; }
+    void set_iteration_duration(Variant<double, String> iteration_duration) { m_iteration_duration = move(iteration_duration); }
+
+    Bindings::PlaybackDirection playback_direction() const { return m_playback_direction; }
+    void set_playback_direction(Bindings::PlaybackDirection playback_direction) { m_playback_direction = playback_direction; }
+
+    String const& easing_function() const { return m_easing_function; }
+    void set_easing_function(String easing_function) { m_easing_function = move(easing_function); }
+
+protected:
+    AnimationEffect(JS::Realm&);
+
+    virtual void initialize(JS::Realm&) override;
+
+    // https://www.w3.org/TR/web-animations-1/#start-delay
+    double m_start_delay { 0.0 };
+
+    // https://www.w3.org/TR/web-animations-1/#end-delay
+    double m_end_delay { 0.0 };
+
+    // https://www.w3.org/TR/web-animations-1/#fill-mode
+    Bindings::FillMode m_fill_mode { Bindings::FillMode::Auto };
+
+    // https://www.w3.org/TR/web-animations-1/#iteration-start
+    double m_iteration_start { 0.0 };
+
+    // https://www.w3.org/TR/web-animations-1/#iteration-count
+    double m_iteration_count { 1.0 };
+
+    // https://www.w3.org/TR/web-animations-1/#iteration-duration
+    Variant<double, String> m_iteration_duration { 0.0 };
+
+    // https://www.w3.org/TR/web-animations-1/#playback-direction
+    Bindings::PlaybackDirection m_playback_direction { Bindings::PlaybackDirection::Normal };
+
+    // https://www.w3.org/TR/css-easing-1/#easing-function
+    String m_easing_function { "linear"_string };
+};
+
+}