Computing animated style should not require renderers
[WebKit-https.git] / Source / WebCore / page / animation / CompositeAnimation.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 "CSSAnimationController.h"
32 #include "ImplicitAnimation.h"
33 #include "KeyframeAnimation.h"
34 #include <wtf/HashMap.h>
35 #include <wtf/text/AtomicString.h>
36
37 namespace WebCore {
38
39 class CSSAnimationControllerPrivate;
40 class CSSAnimationController;
41 class RenderElement;
42 class RenderStyle;
43
44 // A CompositeAnimation represents a collection of animations that are running
45 // on a single RenderElement, such as a number of properties transitioning at once.
46 class CompositeAnimation : public RefCounted<CompositeAnimation> {
47     WTF_MAKE_FAST_ALLOCATED;
48 public:
49     static Ref<CompositeAnimation> create(CSSAnimationControllerPrivate& animationController)
50     {
51         return adoptRef(*new CompositeAnimation(animationController));
52     };
53
54     ~CompositeAnimation();
55     
56     void clearElement();
57
58     AnimationUpdate animate(Element&, const RenderStyle* currentStyle, const RenderStyle& targetStyle);
59     std::unique_ptr<RenderStyle> getAnimatedStyle() const;
60     bool computeExtentOfTransformAnimation(LayoutRect&) const;
61
62     std::optional<Seconds> timeToNextService() const;
63     
64     CSSAnimationControllerPrivate& animationController() const { return m_animationController; }
65
66     void suspendAnimations();
67     void resumeAnimations();
68     bool isSuspended() const { return m_suspended; }
69     
70     bool hasAnimations() const  { return !m_transitions.isEmpty() || !m_keyframeAnimations.isEmpty(); }
71
72     bool isAnimatingProperty(CSSPropertyID, bool acceleratedOnly, AnimationBase::RunningState) const;
73
74     KeyframeAnimation* animationForProperty(CSSPropertyID) const;
75
76     void overrideImplicitAnimations(CSSPropertyID);
77     void resumeOverriddenImplicitAnimations(CSSPropertyID);
78
79     bool pauseAnimationAtTime(const AtomicString& name, double t);
80     bool pauseTransitionAtTime(CSSPropertyID, double);
81     unsigned numberOfActiveAnimations() const;
82
83 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
84     bool hasScrollTriggeredAnimation() const { return m_hasScrollTriggeredAnimation; }
85 #endif
86
87     bool hasAnimationThatDependsOnLayout() const { return m_hasAnimationThatDependsOnLayout; }
88
89 private:
90     CompositeAnimation(CSSAnimationControllerPrivate&);
91
92     void updateTransitions(Element&, const RenderStyle* currentStyle, const RenderStyle& targetStyle);
93     void updateKeyframeAnimations(Element&, const RenderStyle* currentStyle, const RenderStyle& targetStyle);
94     
95     typedef HashMap<int, RefPtr<ImplicitAnimation>> CSSPropertyTransitionsMap;
96     typedef HashMap<AtomicStringImpl*, RefPtr<KeyframeAnimation>> AnimationNameMap;
97
98     CSSAnimationControllerPrivate& m_animationController;
99     CSSPropertyTransitionsMap m_transitions;
100     AnimationNameMap m_keyframeAnimations;
101     Vector<AtomicStringImpl*> m_keyframeAnimationOrderMap;
102     bool m_suspended;
103     bool m_hasAnimationThatDependsOnLayout { false };
104 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
105     bool m_hasScrollTriggeredAnimation { false };
106 #endif
107 };
108
109 } // namespace WebCore