src/third_party/WebKit/Source/core/animation/ActiveAnimations.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef ActiveAnimations_h
  32 #define ActiveAnimations_h
  33
  34 #include "core/animation/AnimationStack.h"
  35 #include "core/animation/css/CSSAnimations.h"
  36 #include "wtf/HashCountedSet.h"
  37 #include "wtf/HashMap.h"
  38 #include "wtf/RefPtr.h"
  39 #include "wtf/Vector.h"
  40
  41 namespace blink {
  42
  43 class CSSAnimations;
  44 class RenderObject;
  45 class Element;
  46
  47 using AnimationPlayerCountedSet = WillBeHeapHashCountedSet<RawPtrWillBeWeakMember<AnimationPlayer>>;
  48
  49 class ActiveAnimations : public NoBaseWillBeGarbageCollectedFinalized<ActiveAnimations> {
  50     WTF_MAKE_NONCOPYABLE(ActiveAnimations);
  51 public:
  52     ActiveAnimations();
  53     ~ActiveAnimations();
  54
  55     // Animations that are currently active for this element, their effects will be applied
  56     // during a style recalc. CSS Transitions are included in this stack.
  57     AnimationStack& defaultStack() { return m_defaultStack; }
  58     const AnimationStack& defaultStack() const { return m_defaultStack; }
  59     // Tracks the state of active CSS Animations and Transitions. The individual animations
  60     // will also be part of the default stack, but the mapping betwen animation name and
  61     // player is kept here.
  62     CSSAnimations& cssAnimations() { return m_cssAnimations; }
  63     const CSSAnimations& cssAnimations() const { return m_cssAnimations; }
  64
  65     // AnimationPlayers which have animations targeting this element.
  66     AnimationPlayerCountedSet& players() { return m_players; }
  67
  68     bool isEmpty() const { return m_defaultStack.isEmpty() && m_cssAnimations.isEmpty() && m_players.isEmpty(); }
  69
  70     void cancelAnimationOnCompositor();
  71
  72     void updateAnimationFlags(RenderStyle&);
  73     void setAnimationStyleChange(bool animationStyleChange) { m_animationStyleChange = animationStyleChange; }
  74
  75     const RenderStyle* baseRenderStyle() const;
  76     void updateBaseRenderStyle(const RenderStyle*);
  77     void clearBaseRenderStyle();
  78
  79 #if !ENABLE(OILPAN)
  80     void addAnimation(Animation* animation) { m_animations.append(animation); }
  81     void notifyAnimationDestroyed(Animation* animation) { m_animations.remove(m_animations.find(animation)); }
  82 #endif
  83
  84     void trace(Visitor*);
  85
  86 private:
  87     bool isAnimationStyleChange() const { return m_animationStyleChange; }
  88
  89     AnimationStack m_defaultStack;
  90     CSSAnimations m_cssAnimations;
  91     AnimationPlayerCountedSet m_players;
  92     bool m_animationStyleChange;
  93     RefPtr<RenderStyle> m_baseRenderStyle;
  94
  95 #if !ENABLE(OILPAN)
  96     // FIXME: Oilpan: This is to avoid a reference cycle that keeps Elements alive
  97     // and won't be needed once the Node hierarchy becomes traceable.
  98     Vector<Animation*> m_animations;
  99 #endif
 100
 101     // CSSAnimations checks if a style change is due to animation.
 102     friend class CSSAnimations;
 103 };
 104
 105 } // namespace blink
 106
 107 #endif