src/third_party/WebKit/Source/core/animation/Animation.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 Animation_h
  32 #define Animation_h
  33
  34 #include "core/animation/AnimationEffect.h"
  35 #include "core/animation/TimedItem.h"
  36 #include "wtf/RefPtr.h"
  37
  38 namespace WebCore {
  39
  40 class Element;
  41
  42 class Animation FINAL : public TimedItem {
  43
  44 public:
  45     enum Priority { DefaultPriority, TransitionPriority };
  46
  47     static PassRefPtr<Animation> create(PassRefPtr<Element>, PassRefPtr<AnimationEffect>, const Timing&, Priority = DefaultPriority, PassOwnPtr<EventDelegate> = nullptr);
  48     virtual bool isAnimation() const OVERRIDE { return true; }
  49
  50     const AnimationEffect::CompositableValueList* compositableValues() const
  51     {
  52         ASSERT(m_compositableValues);
  53         return m_compositableValues.get();
  54     }
  55
  56     bool affects(CSSPropertyID) const;
  57     const AnimationEffect* effect() const { return m_effect.get(); }
  58     Priority priority() const { return m_priority; }
  59     Element* target() { return m_target.get(); }
  60
  61     bool isCandidateForAnimationOnCompositor() const;
  62     // Must only be called once and assumes to be part of a player without a start time.
  63     bool maybeStartAnimationOnCompositor();
  64     bool hasActiveAnimationsOnCompositor() const;
  65     bool hasActiveAnimationsOnCompositor(CSSPropertyID) const;
  66     void cancelAnimationOnCompositor();
  67     void pauseAnimationForTestingOnCompositor(double pauseTime);
  68
  69 protected:
  70     // Returns whether style recalc was triggered.
  71     bool applyEffects(bool previouslyInEffect);
  72     void clearEffects();
  73     virtual bool updateChildrenAndEffects() const OVERRIDE;
  74     virtual void didAttach() OVERRIDE;
  75     virtual void willDetach() OVERRIDE;
  76     virtual double calculateTimeToEffectChange(double inheritedTime, double timeToNextIteration) const OVERRIDE;
  77
  78 private:
  79     Animation(PassRefPtr<Element>, PassRefPtr<AnimationEffect>, const Timing&, Priority, PassOwnPtr<EventDelegate>);
  80
  81     RefPtr<Element> m_target;
  82     RefPtr<AnimationEffect> m_effect;
  83
  84     bool m_activeInAnimationStack;
  85     OwnPtr<AnimationEffect::CompositableValueList> m_compositableValues;
  86
  87     Priority m_priority;
  88
  89     Vector<int> m_compositorAnimationIds;
  90
  91     friend class CSSAnimations;
  92 };
  93
  94 DEFINE_TYPE_CASTS(Animation, TimedItem, timedItem, timedItem->isAnimation(), timedItem.isAnimation());
  95
  96 } // namespace WebCore
  97
  98 #endif