third_party/blink/renderer/core/animation/animation_effect.h

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_ANIMATION_EFFECT_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_ANIMATION_EFFECT_H_

#include <optional>

#include "third_party/blink/renderer/core/animation/animation_time_delta.h"
#include "third_party/blink/renderer/core/animation/timing.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/bindings/script_wrappable.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/member.h"

namespace blink {

class Animation;
enum class TimelinePhase;
class AnimationEffectOwner;
class EffectTiming;
class ComputedEffectTiming;
class OptionalEffectTiming;
class PropertyHandle;
class WorkletAnimation;

enum TimingUpdateReason {
  kTimingUpdateOnDemand,
  kTimingUpdateForAnimationFrame
};

// Represents the content of an Animation and its fractional timing state.
// https://w3.org/TR/web-animations-1/#the-animationeffect-interface
class CORE_EXPORT AnimationEffect : public ScriptWrappable {
  DEFINE_WRAPPERTYPEINFO();
  // Calls Attach/Detach, GetAnimation, UpdateInheritedTime.
  friend class Animation;
  friend class WorkletAnimation;

  // Calls GetAnimation().
  // TODO(majidvp): Remove this. EffectStack should not need to access animation
  // directly.
  friend class EffectStack;

 public:
  class EventDelegate : public GarbageCollected<EventDelegate> {
   public:
    virtual ~EventDelegate() = default;
    virtual bool RequiresIterationEvents(const AnimationEffect&) = 0;
    virtual void OnEventCondition(const AnimationEffect&, Timing::Phase) = 0;
    virtual bool IsAnimationEventDelegate() const { return false; }
    virtual bool IsTransitionEventDelegate() const { return false; }
    virtual void Trace(Visitor* visitor) const {}
  };

  ~AnimationEffect() override = default;

  virtual bool IsKeyframeEffect() const { return false; }
  virtual bool IsInertEffect() const { return false; }

  virtual bool Affects(const PropertyHandle&) const = 0;

  Timing::Phase GetPhase() const { return EnsureCalculated().phase; }
  bool IsCurrent() const { return EnsureCalculated().is_current; }
  bool IsInEffect() const { return EnsureCalculated().is_in_effect; }
  bool IsInPlay() const { return EnsureCalculated().is_in_play; }
  std::optional<double> CurrentIteration() const {
    return EnsureCalculated().current_iteration;
  }
  std::optional<double> Progress() const { return EnsureCalculated().progress; }
  AnimationTimeDelta TimeToForwardsEffectChange() const {
    return EnsureCalculated().time_to_forwards_effect_change;
  }
  AnimationTimeDelta TimeToReverseEffectChange() const {
    return EnsureCalculated().time_to_reverse_effect_change;
  }
  std::optional<AnimationTimeDelta> LocalTime() const {
    return EnsureCalculated().local_time;
  }

  const Timing& SpecifiedTiming() const { return timing_; }

  const Timing::NormalizedTiming& NormalizedTiming() const {
    EnsureNormalizedTiming();
    return normalized_.value();
  }
  void InvalidateNormalizedTiming() const { normalized_.reset(); }

  void UpdateSpecifiedTiming(const Timing&);
  void SetIgnoreCssTimingProperties();

  EventDelegate* GetEventDelegate() { return event_delegate_.Get(); }
  void SetEventDelegate(EventDelegate* delegate) { event_delegate_ = delegate; }

  EffectTiming* getTiming() const;
  ComputedEffectTiming* getComputedTiming();
  void updateTiming(OptionalEffectTiming*,
                    ExceptionState& = ASSERT_NO_EXCEPTION);
  AnimationTimeDelta GetCancelTime() const { return cancel_time_; }
  void SetCancelTime(AnimationTimeDelta cancel_time) {
    cancel_time_ = cancel_time;
  }

  // Attach/Detach the AnimationEffect from its owning animation.
  virtual void Attach(AnimationEffectOwner* owner) {
    owner_ = owner;
    InvalidateNormalizedTiming();
  }
  virtual void Detach() {
    DCHECK(owner_);
    owner_ = nullptr;
  }

  const Animation* GetAnimationForTesting() const { return GetAnimation(); }

  void Trace(Visitor*) const override;

 protected:
  explicit AnimationEffect(const Timing&, EventDelegate* = nullptr);

  // When AnimationEffect receives a new inherited time via UpdateInheritedTime
  // it will (if necessary) recalculate timings and (if necessary) call
  // UpdateChildrenAndEffects.
  void UpdateInheritedTime(std::optional<AnimationTimeDelta> inherited_time,
                           bool is_idle,
                           double inherited_playback_rate,
                           TimingUpdateReason) const;
  void Invalidate() const { needs_update_ = true; }
  void InvalidateAndNotifyOwner() const;
  bool RequiresIterationEvents() const {
    return event_delegate_ && event_delegate_->RequiresIterationEvents(*this);
  }
  void ClearEventDelegate() { event_delegate_ = nullptr; }

  virtual void UpdateChildrenAndEffects() const = 0;

  // This is the value of the iteration duration when it is specified as 'auto'.
  // In web-animations-1, auto is treated as "the value zero for the purpose of
  // timing model calculations and for the result of the duration member
  // returned from getComputedTiming()".
  virtual AnimationTimeDelta IntrinsicIterationDuration() const;

  virtual AnimationTimeDelta CalculateTimeToEffectChange(
      bool forwards,
      std::optional<AnimationTimeDelta> local_time,
      AnimationTimeDelta time_to_next_iteration) const = 0;

  const Animation* GetAnimation() const;
  Animation* GetAnimation();

  virtual std::optional<AnimationTimeDelta> TimelineDuration() const = 0;

  Member<AnimationEffectOwner> owner_;
  Timing timing_;
  Member<EventDelegate> event_delegate_;

  mutable Timing::CalculatedTiming calculated_;
  mutable std::optional<Timing::NormalizedTiming> normalized_;
  mutable bool needs_update_;
  mutable std::optional<AnimationTimeDelta> last_update_time_;
  mutable bool last_is_idle_ = false;
  AnimationTimeDelta cancel_time_;
  const Timing::CalculatedTiming& EnsureCalculated() const;
  void EnsureNormalizedTiming() const;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_ANIMATION_EFFECT_H_