Animations and Transitions should not start when globally suspended
[WebKit-https.git] / Source / WebCore / page / animation / AnimationController.h
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 AnimationController_h
30 #define AnimationController_h
31
32 #include "CSSPropertyNames.h"
33 #include <wtf/Forward.h>
34 #include <wtf/OwnPtr.h>
35
36 namespace WebCore {
37
38 class AnimationBase;
39 class AnimationControllerPrivate;
40 class Document;
41 class Element;
42 class Frame;
43 class Node;
44 class RenderObject;
45 class RenderStyle;
46
47 class AnimationController {
48 public:
49     AnimationController(Frame*);
50     ~AnimationController();
51
52     void cancelAnimations(RenderObject*);
53     PassRefPtr<RenderStyle> updateAnimations(RenderObject*, RenderStyle* newStyle);
54     PassRefPtr<RenderStyle> getAnimatedStyleForRenderer(RenderObject*);
55
56     // This is called when an accelerated animation or transition has actually started to animate.
57     void notifyAnimationStarted(RenderObject*, double startTime);
58
59     bool pauseAnimationAtTime(RenderObject*, const AtomicString& name, double t); // To be used only for testing
60     bool pauseTransitionAtTime(RenderObject*, const String& property, double t); // To be used only for testing
61     unsigned numberOfActiveAnimations(Document*) const; // To be used only for testing
62     
63     bool isRunningAnimationOnRenderer(RenderObject*, CSSPropertyID, bool isRunningNow = true) const;
64     bool isRunningAcceleratedAnimationOnRenderer(RenderObject*, CSSPropertyID, bool isRunningNow = true) const;
65
66     bool isSuspended() const;
67     void suspendAnimations();
68     void resumeAnimations();
69 #if ENABLE(REQUEST_ANIMATION_FRAME)
70     void serviceAnimations();
71 #endif
72
73     void suspendAnimationsForDocument(Document*);
74     void resumeAnimationsForDocument(Document*);
75     void startAnimationsIfNotSuspended(Document*);
76
77     void beginAnimationUpdate();
78     void endAnimationUpdate();
79     
80     static bool supportsAcceleratedAnimationOfProperty(CSSPropertyID);
81
82 private:
83     OwnPtr<AnimationControllerPrivate> m_data;
84     int m_beginAnimationUpdateCount;
85 };
86
87 class AnimationUpdateBlock {
88 public:
89     AnimationUpdateBlock(AnimationController* animationController)
90         : m_animationController(animationController)
91     {
92         if (m_animationController)
93             m_animationController->beginAnimationUpdate();
94     }
95     
96     ~AnimationUpdateBlock()
97     {
98         if (m_animationController)
99             m_animationController->endAnimationUpdate();
100     }
101     
102     AnimationController* m_animationController;
103 };
104
105 } // namespace WebCore
106
107 #endif // AnimationController_h