1/*
2 * Copyright (C) 2007 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef KeyframeAnimation_h
30#define KeyframeAnimation_h
31
32#include "AnimationBase.h"
33#include "Document.h"
34#include "KeyframeList.h"
35
36namespace WebCore {
37
38class RenderStyle;
39
40// A KeyframeAnimation tracks the state of an explicit animation for a single RenderElement.
41class KeyframeAnimation final : public AnimationBase {
42public:
43    static RefPtr<KeyframeAnimation> create(const Animation& animation, RenderElement* renderer, int index, CompositeAnimation* compositeAnimation, RenderStyle* unanimatedStyle)
44    {
45        return adoptRef(new KeyframeAnimation(animation, renderer, index, compositeAnimation, unanimatedStyle));
46    }
47
48    virtual void animate(CompositeAnimation*, RenderElement*, const RenderStyle* currentStyle, RenderStyle* targetStyle, RefPtr<RenderStyle>& animatedStyle) override;
49    virtual void getAnimatedStyle(RefPtr<RenderStyle>&) override;
50
51    const KeyframeList& keyframes() const { return m_keyframes; }
52
53    const AtomicString& name() const { return m_keyframes.animationName(); }
54    int index() const { return m_index; }
55    void setIndex(int i) { m_index = i; }
56
57    bool hasAnimationForProperty(CSSPropertyID) const;
58
59    void setUnanimatedStyle(PassRefPtr<RenderStyle> style) { m_unanimatedStyle = style; }
60    RenderStyle* unanimatedStyle() const { return m_unanimatedStyle.get(); }
61
62    virtual double timeToNextService() override;
63
64protected:
65    virtual void onAnimationStart(double elapsedTime) override;
66    virtual void onAnimationIteration(double elapsedTime) override;
67    virtual void onAnimationEnd(double elapsedTime) override;
68    virtual bool startAnimation(double timeOffset) override;
69    virtual void pauseAnimation(double timeOffset) override;
70    virtual void endAnimation() override;
71
72    virtual void overrideAnimations() override;
73    virtual void resumeOverriddenAnimations() override;
74
75    bool shouldSendEventForListener(Document::ListenerType inListenerType) const;
76    bool sendAnimationEvent(const AtomicString&, double elapsedTime);
77
78    virtual bool affectsProperty(CSSPropertyID) const override;
79
80    void validateTransformFunctionList();
81#if ENABLE(CSS_FILTERS)
82    void checkForMatchingFilterFunctionLists();
83#endif
84
85private:
86    KeyframeAnimation(const Animation&, RenderElement*, int index, CompositeAnimation*, RenderStyle* unanimatedStyle);
87    virtual ~KeyframeAnimation();
88
89    // Get the styles for the given property surrounding the current animation time and the progress between them.
90    void fetchIntervalEndpointsForProperty(CSSPropertyID, const RenderStyle*& fromStyle, const RenderStyle*& toStyle, double& progress) const;
91
92    // The keyframes that we are blending.
93    KeyframeList m_keyframes;
94
95    // The order in which this animation appears in the animation-name style.
96    int m_index;
97    bool m_startEventDispatched;
98
99    // The style just before we started animation
100    RefPtr<RenderStyle> m_unanimatedStyle;
101};
102
103} // namespace WebCore
104
105#endif // KeyframeAnimation_h
106