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 Computer, 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
41// for a single RenderObject.
42class KeyframeAnimation : public AnimationBase {
43public:
44    static PassRefPtr<KeyframeAnimation> create(const Animation* animation, RenderObject* renderer, int index, CompositeAnimation* compositeAnimation, RenderStyle* unanimatedStyle)
45    {
46        return adoptRef(new KeyframeAnimation(animation, renderer, index, compositeAnimation, unanimatedStyle));
47    };
48
49    virtual void animate(CompositeAnimation*, RenderObject*, const RenderStyle* currentStyle, RenderStyle* targetStyle, RefPtr<RenderStyle>& animatedStyle);
50    virtual void getAnimatedStyle(RefPtr<RenderStyle>& animatedStyle);
51
52    const KeyframeList& keyframes() const { return m_keyframes; }
53
54    const AtomicString& name() const { return m_keyframes.animationName(); }
55    int index() const { return m_index; }
56    void setIndex(int i) { m_index = i; }
57
58    bool hasAnimationForProperty(CSSPropertyID) const;
59
60    void setUnanimatedStyle(PassRefPtr<RenderStyle> style) { m_unanimatedStyle = style; }
61    RenderStyle* unanimatedStyle() const { return m_unanimatedStyle.get(); }
62
63    virtual double timeToNextService();
64
65protected:
66    virtual void onAnimationStart(double elapsedTime);
67    virtual void onAnimationIteration(double elapsedTime);
68    virtual void onAnimationEnd(double elapsedTime);
69    virtual bool startAnimation(double timeOffset);
70    virtual void pauseAnimation(double timeOffset);
71    virtual void endAnimation();
72
73    virtual void overrideAnimations();
74    virtual void resumeOverriddenAnimations();
75
76    bool shouldSendEventForListener(Document::ListenerType inListenerType) const;
77    bool sendAnimationEvent(const AtomicString&, double elapsedTime);
78
79    virtual bool affectsProperty(CSSPropertyID) const;
80
81    void validateTransformFunctionList();
82#if ENABLE(CSS_FILTERS)
83    void checkForMatchingFilterFunctionLists();
84#endif
85
86private:
87    KeyframeAnimation(const Animation* animation, RenderObject*, int index, CompositeAnimation*, RenderStyle* unanimatedStyle);
88    virtual ~KeyframeAnimation();
89
90    // Get the styles for the given property surrounding the current animation time and the progress between them.
91    void fetchIntervalEndpointsForProperty(CSSPropertyID, const RenderStyle*& fromStyle, const RenderStyle*& toStyle, double& progress) const;
92
93    // The keyframes that we are blending.
94    KeyframeList m_keyframes;
95
96    // The order in which this animation appears in the animation-name style.
97    int m_index;
98    bool m_startEventDispatched;
99
100    // The style just before we started animation
101    RefPtr<RenderStyle> m_unanimatedStyle;
102};
103
104} // namespace WebCore
105
106#endif // KeyframeAnimation_h
107