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 class Dictionary;
  42
  43 class Animation FINAL : public TimedItem {
  44
  45 public:
  46     enum Priority { DefaultPriority, TransitionPriority };
  47
  48     static PassRefPtr<Animation> create(PassRefPtr<Element>, PassRefPtr<AnimationEffect>, const Timing&, Priority = DefaultPriority, PassOwnPtr<EventDelegate> = nullptr);
  49     // Web Animations API Bindings constructors.
  50     static PassRefPtr<Animation> create(Element*, Vector<Dictionary> keyframeDictionaryVector, Dictionary timingInput);
  51     static PassRefPtr<Animation> create(Element*, Vector<Dictionary> keyframeDictionaryVector, double timingInput);
  52     static PassRefPtr<Animation> create(Element*, Vector<Dictionary> keyframeDictionaryVector);
  53
  54     // FIXME: Move all of these setter methods out of Animation,
  55     // possibly into a new class (TimingInput?).
  56     static void setStartDelay(Timing&, double startDelay);
  57     static void setEndDelay(Timing&, double endDelay);
  58     static void setFillMode(Timing&, String fillMode);
  59     static void setIterationStart(Timing&, double iterationStart);
  60     static void setIterationCount(Timing&, double iterationCount);
  61     static void setIterationDuration(Timing&, double iterationDuration);
  62     static void setPlaybackRate(Timing&, double playbackRate);
  63     static void setPlaybackDirection(Timing&, String direction);
  64     static void setTimingFunction(Timing&, String timingFunctionString);
  65
  66     virtual bool isAnimation() const OVERRIDE { return true; }
  67
  68     const AnimationEffect::CompositableValueList* compositableValues() const
  69     {
  70         ASSERT(m_compositableValues);
  71         return m_compositableValues.get();
  72     }
  73
  74     bool affects(CSSPropertyID) const;
  75     const AnimationEffect* effect() const { return m_effect.get(); }
  76     Priority priority() const { return m_priority; }
  77     Element* target() { return m_target.get(); }
  78
  79     bool isCandidateForAnimationOnCompositor() const;
  80     // Must only be called once and assumes to be part of a player without a start time.
  81     bool maybeStartAnimationOnCompositor();
  82     bool hasActiveAnimationsOnCompositor() const;
  83     bool hasActiveAnimationsOnCompositor(CSSPropertyID) const;
  84     void cancelAnimationOnCompositor();
  85     void pauseAnimationForTestingOnCompositor(double pauseTime);
  86
  87 protected:
  88     // Returns whether style recalc was triggered.
  89     bool applyEffects(bool previouslyInEffect);
  90     void clearEffects();
  91     virtual bool updateChildrenAndEffects() const OVERRIDE;
  92     virtual void didAttach() OVERRIDE;
  93     virtual void willDetach() OVERRIDE;
  94     virtual double calculateTimeToEffectChange(bool forwards, double inheritedTime, double timeToNextIteration) const OVERRIDE;
  95
  96 private:
  97     static void populateTiming(Timing&, Dictionary);
  98     // createUnsafe should only be directly called from tests.
  99     static PassRefPtr<Animation> createUnsafe(Element*, Vector<Dictionary> keyframeDictionaryVector, Dictionary timingInput);
 100     static PassRefPtr<Animation> createUnsafe(Element*, Vector<Dictionary> keyframeDictionaryVector, double timingInput);
 101     static PassRefPtr<Animation> createUnsafe(Element*, Vector<Dictionary> keyframeDictionaryVector);
 102
 103     Animation(PassRefPtr<Element>, PassRefPtr<AnimationEffect>, const Timing&, Priority, PassOwnPtr<EventDelegate>);
 104
 105     RefPtr<Element> m_target;
 106     RefPtr<AnimationEffect> m_effect;
 107
 108     bool m_activeInAnimationStack;
 109     OwnPtr<AnimationEffect::CompositableValueList> m_compositableValues;
 110
 111     Priority m_priority;
 112
 113     Vector<int> m_compositorAnimationIds;
 114
 115     friend class CSSAnimations;
 116     friend class AnimationAnimationTest;
 117 };
 118
 119 DEFINE_TYPE_CASTS(Animation, TimedItem, timedItem, timedItem->isAnimation(), timedItem.isAnimation());
 120
 121 } // namespace WebCore
 122
 123 #endif