Animation.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /*
  2. * Copyright (c) 2023-2024, Matthew Olsson <mattco@serenityos.org>.
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <LibJS/Runtime/PromiseCapability.h>
  8. #include <LibWeb/Bindings/AnimationPrototype.h>
  9. #include <LibWeb/DOM/EventTarget.h>
  10. namespace Web::Animations {
  11. // Sorted by composite order:
  12. // https://www.w3.org/TR/css-animations-2/#animation-composite-order
  13. enum class AnimationClass {
  14. CSSAnimationWithOwningElement,
  15. CSSTransition,
  16. CSSAnimationWithoutOwningElement,
  17. None,
  18. };
  19. // https://www.w3.org/TR/web-animations-1/#the-animation-interface
  20. class Animation : public DOM::EventTarget {
  21. WEB_PLATFORM_OBJECT(Animation, DOM::EventTarget);
  22. JS_DECLARE_ALLOCATOR(Animation);
  23. public:
  24. static JS::NonnullGCPtr<Animation> create(JS::Realm&, JS::GCPtr<AnimationEffect>, Optional<JS::GCPtr<AnimationTimeline>>);
  25. static WebIDL::ExceptionOr<JS::NonnullGCPtr<Animation>> construct_impl(JS::Realm&, JS::GCPtr<AnimationEffect>, Optional<JS::GCPtr<AnimationTimeline>>);
  26. FlyString const& id() const { return m_id; }
  27. void set_id(FlyString value) { m_id = move(value); }
  28. JS::GCPtr<AnimationEffect> effect() const { return m_effect; }
  29. void set_effect(JS::GCPtr<AnimationEffect>);
  30. JS::GCPtr<AnimationTimeline> timeline() const { return m_timeline; }
  31. void set_timeline(JS::GCPtr<AnimationTimeline>);
  32. Optional<double> const& start_time() const { return m_start_time; }
  33. void set_start_time(Optional<double> const&);
  34. Optional<double> current_time() const;
  35. WebIDL::ExceptionOr<void> set_current_time(Optional<double> const&);
  36. double playback_rate() const { return m_playback_rate; }
  37. WebIDL::ExceptionOr<void> set_playback_rate(double value);
  38. Bindings::AnimationPlayState play_state() const;
  39. bool is_relevant() const;
  40. bool is_replaceable() const;
  41. Bindings::AnimationReplaceState replace_state() const { return m_replace_state; }
  42. void set_replace_state(Bindings::AnimationReplaceState value);
  43. // https://www.w3.org/TR/web-animations-1/#dom-animation-pending
  44. bool pending() const { return m_pending_play_task == TaskState::Scheduled || m_pending_pause_task == TaskState::Scheduled; }
  45. // https://www.w3.org/TR/web-animations-1/#dom-animation-ready
  46. JS::NonnullGCPtr<JS::Object> ready() const { return *current_ready_promise()->promise(); }
  47. // https://www.w3.org/TR/web-animations-1/#dom-animation-finished
  48. JS::NonnullGCPtr<JS::Object> finished() const { return *current_finished_promise()->promise(); }
  49. bool is_finished() const { return m_is_finished; }
  50. enum class AutoRewind {
  51. Yes,
  52. No,
  53. };
  54. WebIDL::ExceptionOr<void> play();
  55. WebIDL::ExceptionOr<void> play_an_animation(AutoRewind);
  56. Optional<double> convert_an_animation_time_to_timeline_time(Optional<double>) const;
  57. Optional<double> convert_a_timeline_time_to_an_origin_relative_time(Optional<double>) const;
  58. JS::GCPtr<DOM::Document> document_for_timing() const;
  59. void notify_timeline_time_did_change();
  60. void effect_timing_changed(Badge<AnimationEffect>);
  61. virtual bool is_css_animation() const { return false; }
  62. virtual AnimationClass animation_class() const { return AnimationClass::None; }
  63. virtual Optional<int> class_specific_composite_order(JS::NonnullGCPtr<Animation>) const { return {}; }
  64. unsigned int global_animation_list_order() const { return m_global_animation_list_order; }
  65. protected:
  66. Animation(JS::Realm&);
  67. virtual void initialize(JS::Realm&) override;
  68. virtual void visit_edges(Cell::Visitor&) override;
  69. private:
  70. enum class TaskState {
  71. None,
  72. Scheduled,
  73. };
  74. enum class DidSeek {
  75. Yes,
  76. No,
  77. };
  78. enum class SynchronouslyNotify {
  79. Yes,
  80. No,
  81. };
  82. double associated_effect_end() const;
  83. double effective_playback_rate() const;
  84. void apply_any_pending_playback_rate();
  85. WebIDL::ExceptionOr<void> silently_set_current_time(Optional<double>);
  86. void update_finished_state(DidSeek, SynchronouslyNotify);
  87. void run_pending_play_task();
  88. void run_pending_pause_task();
  89. JS::NonnullGCPtr<WebIDL::Promise> current_ready_promise() const;
  90. JS::NonnullGCPtr<WebIDL::Promise> current_finished_promise() const;
  91. void invalidate_effect();
  92. // https://www.w3.org/TR/web-animations-1/#dom-animation-id
  93. FlyString m_id;
  94. // https://www.w3.org/TR/web-animations-1/#global-animation-list
  95. unsigned int m_global_animation_list_order { 0 };
  96. // https://www.w3.org/TR/web-animations-1/#dom-animation-effect
  97. JS::GCPtr<AnimationEffect> m_effect;
  98. // https://www.w3.org/TR/web-animations-1/#dom-animation-timeline
  99. JS::GCPtr<AnimationTimeline> m_timeline;
  100. // https://www.w3.org/TR/web-animations-1/#animation-start-time
  101. Optional<double> m_start_time {};
  102. // https://www.w3.org/TR/web-animations-1/#animation-hold-time
  103. Optional<double> m_hold_time {};
  104. // https://www.w3.org/TR/web-animations-1/#previous-current-time
  105. Optional<double> m_previous_current_time {};
  106. // https://www.w3.org/TR/web-animations-1/#playback-rate
  107. double m_playback_rate { 1.0 };
  108. // https://www.w3.org/TR/web-animations-1/#pending-playback-rate
  109. Optional<double> m_pending_playback_rate {};
  110. // https://www.w3.org/TR/web-animations-1/#dom-animation-replacestate
  111. Bindings::AnimationReplaceState m_replace_state { Bindings::AnimationReplaceState::Active };
  112. // Note: The following promises are initialized lazily to avoid constructing them outside of an execution context
  113. // https://www.w3.org/TR/web-animations-1/#current-ready-promise
  114. mutable JS::GCPtr<WebIDL::Promise> m_current_ready_promise;
  115. // https://www.w3.org/TR/web-animations-1/#current-finished-promise
  116. mutable JS::GCPtr<WebIDL::Promise> m_current_finished_promise;
  117. bool m_is_finished { false };
  118. // https://www.w3.org/TR/web-animations-1/#pending-play-task
  119. TaskState m_pending_play_task { TaskState::None };
  120. // https://www.w3.org/TR/web-animations-1/#pending-pause-task
  121. TaskState m_pending_pause_task { TaskState::None };
  122. Optional<int> m_pending_finish_microtask_id;
  123. };
  124. }