25c86d3209dd7f38c58349bb5e6d36fed37e9863
[WebKit-https.git] / Source / WebCore / page / animation / CSSAnimationController.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 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 #pragma once
30
31 #include "AnimationBase.h"
32 #include "CSSPropertyNames.h"
33 #include "RenderStyle.h"
34 #include <wtf/Forward.h>
35
36 namespace WebCore {
37
38 class CSSAnimationControllerPrivate;
39 class Document;
40 class Element;
41 class Frame;
42 class LayoutRect;
43 class RenderElement;
44
45 struct AnimationUpdate {
46 #if !COMPILER_SUPPORTS(NSDMI_FOR_AGGREGATES)
47     AnimationUpdate() = default;
48     AnimationUpdate(std::unique_ptr<RenderStyle> style, bool stateChanged)
49         : style(WTFMove(style))
50         , stateChanged(stateChanged)
51     { }
52 #endif
53     std::unique_ptr<RenderStyle> style;
54     bool stateChanged { false };
55 };
56
57 class CSSAnimationController {
58     WTF_MAKE_FAST_ALLOCATED;
59 public:
60     explicit CSSAnimationController(Frame&);
61     ~CSSAnimationController();
62
63     void cancelAnimations(Element&);
64     AnimationUpdate updateAnimations(Element&, const RenderStyle& newStyle, const RenderStyle* oldStyle);
65     std::unique_ptr<RenderStyle> animatedStyleForRenderer(RenderElement&);
66
67     // If possible, compute the visual extent of any transform animation on the given renderer
68     // using the given rect, returning the result in the rect. Return false if there is some
69     // transform animation but we were unable to cheaply compute its affect on the extent.
70     bool computeExtentOfAnimation(RenderElement&, LayoutRect&) const;
71
72     // This is called when an accelerated animation or transition has actually started to animate.
73     void notifyAnimationStarted(RenderElement&, double startTime);
74
75     WEBCORE_EXPORT bool pauseAnimationAtTime(Element&, const AtomicString& name, double t); // To be used only for testing
76     WEBCORE_EXPORT bool pauseTransitionAtTime(Element&, const String& property, double t); // To be used only for testing
77     WEBCORE_EXPORT unsigned numberOfActiveAnimations(Document*) const; // To be used only for testing
78     
79     bool isRunningAnimationOnRenderer(RenderElement&, CSSPropertyID, AnimationBase::RunningState) const;
80     bool isRunningAcceleratedAnimationOnRenderer(RenderElement&, CSSPropertyID, AnimationBase::RunningState) const;
81
82     WEBCORE_EXPORT bool isSuspended() const;
83     WEBCORE_EXPORT void suspendAnimations();
84     WEBCORE_EXPORT void resumeAnimations();
85     void serviceAnimations();
86
87     void updateThrottlingState();
88     WEBCORE_EXPORT Seconds animationInterval() const;
89
90     WEBCORE_EXPORT void suspendAnimationsForDocument(Document*);
91     WEBCORE_EXPORT void resumeAnimationsForDocument(Document*);
92     WEBCORE_EXPORT bool animationsAreSuspendedForDocument(Document*);
93     void detachFromDocument(Document*);
94     void startAnimationsIfNotSuspended(Document*);
95
96     void beginAnimationUpdate();
97     void endAnimationUpdate();
98
99     WEBCORE_EXPORT bool allowsNewAnimationsWhileSuspended() const;
100     WEBCORE_EXPORT void setAllowsNewAnimationsWhileSuspended(bool);
101     
102     static bool supportsAcceleratedAnimationOfProperty(CSSPropertyID);
103
104 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
105     bool wantsScrollUpdates() const;
106     void scrollWasUpdated();
107 #endif
108
109     bool hasAnimations() const;
110
111 private:
112     const std::unique_ptr<CSSAnimationControllerPrivate> m_data;
113 };
114
115 class AnimationUpdateBlock {
116 public:
117     AnimationUpdateBlock(CSSAnimationController* animationController)
118         : m_animationController(animationController)
119     {
120         if (m_animationController)
121             m_animationController->beginAnimationUpdate();
122     }
123     
124     ~AnimationUpdateBlock()
125     {
126         if (m_animationController)
127             m_animationController->endAnimationUpdate();
128     }
129     
130     CSSAnimationController* m_animationController;
131 };
132
133 } // namespace WebCore