ce14e51865e75e0006914c6a998ec971049d3bbf
[WebKit-https.git] / Source / WebCore / animation / DeclarativeAnimation.h
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "AnimationEffectReadOnly.h"
29 #include "GenericEventQueue.h"
30 #include "WebAnimation.h"
31 #include <wtf/Ref.h>
32
33 namespace WebCore {
34
35 class Animation;
36 class Element;
37 class RenderStyle;
38
39 class DeclarativeAnimation : public WebAnimation {
40 public:
41     ~DeclarativeAnimation();
42
43     bool isDeclarativeAnimation() const final { return true; }
44
45     const Animation& backingAnimation() const { return m_backingAnimation; }
46     void setBackingAnimation(const Animation&);
47     void invalidateDOMEvents(Seconds elapsedTime = 0_s);
48
49     void setTimeline(RefPtr<AnimationTimeline>&&) final;
50     void cancel() final;
51
52 protected:
53     DeclarativeAnimation(Element&, const Animation&);
54
55     virtual void initialize(const Element&, const RenderStyle* oldStyle, const RenderStyle& newStyle);
56     virtual void syncPropertiesWithBackingAnimation();
57
58 private:
59     AnimationEffectReadOnly::Phase phaseWithoutEffect() const;
60     void enqueueDOMEvent(const AtomicString&, Seconds);
61     void remove() final;
62
63     Element& m_target;
64     Ref<Animation> m_backingAnimation;
65     bool m_wasPending { false };
66     AnimationEffectReadOnly::Phase m_previousPhase { AnimationEffectReadOnly::Phase::Idle };
67     double m_previousIteration;
68     GenericEventQueue m_eventQueue;
69 };
70
71 } // namespace WebCore
72
73 SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(DeclarativeAnimation, isDeclarativeAnimation())