src/third_party/WebKit/Source/core/animation/css/CSSAnimationData.h

   1 /*
   2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
   3  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
   4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
   5  * Copyright (C) 2003, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
   6  * Copyright (C) 2006 Graham Dennis (graham.dennis@gmail.com)
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public License
  19  * along with this library; see the file COPYING.LIB.  If not, write to
  20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  *
  23  */
  24
  25 #ifndef CSSAnimationData_h
  26 #define CSSAnimationData_h
  27
  28 #include "CSSPropertyNames.h"
  29 #include "core/rendering/style/RenderStyleConstants.h"
  30 #include "platform/animation/TimingFunction.h"
  31 #include "platform/heap/Handle.h"
  32 #include "wtf/PassRefPtr.h"
  33 #include "wtf/RefCounted.h"
  34 #include "wtf/text/WTFString.h"
  35
  36 namespace WebCore {
  37
  38 class CSSAnimationData FINAL : public RefCountedWillBeGarbageCollectedFinalized<CSSAnimationData> {
  39 public:
  40     ~CSSAnimationData();
  41
  42     static PassRefPtrWillBeRawPtr<CSSAnimationData> create()
  43     {
  44         return adoptRefWillBeNoop(new CSSAnimationData);
  45     }
  46
  47     static PassRefPtrWillBeRawPtr<CSSAnimationData> create(const CSSAnimationData* o)
  48     {
  49         return adoptRefWillBeNoop(new CSSAnimationData(*o));
  50     }
  51
  52     bool isDelaySet() const { return m_delaySet; }
  53     bool isDirectionSet() const { return m_directionSet; }
  54     bool isDurationSet() const { return m_durationSet; }
  55     bool isFillModeSet() const { return m_fillModeSet; }
  56     bool isIterationCountSet() const { return m_iterationCountSet; }
  57     bool isNameSet() const { return m_nameSet; }
  58     bool isPlayStateSet() const { return m_playStateSet; }
  59     bool isPropertySet() const { return m_propertySet; }
  60     bool isTimingFunctionSet() const { return m_timingFunctionSet; }
  61
  62     // Flags this to be the special "none" animation (animation-name: none)
  63     bool isNoneAnimation() const { return m_isNone; }
  64     // We can make placeholder CSSAnimationData objects to keep the comma-separated lists
  65     // of properties in sync. isValidAnimation means this is not a placeholder.
  66     bool isValidAnimation() const { return !m_isNone && !m_name.isEmpty(); }
  67
  68     bool isEmpty() const
  69     {
  70         return (!m_directionSet && !m_durationSet && !m_fillModeSet
  71                 && !m_nameSet && !m_playStateSet && !m_iterationCountSet
  72                 && !m_delaySet && !m_timingFunctionSet && !m_propertySet);
  73     }
  74
  75     void clearDelay() { m_delaySet = false; }
  76     void clearDirection() { m_directionSet = false; }
  77     void clearDuration() { m_durationSet = false; }
  78     void clearFillMode() { m_fillModeSet = false; }
  79     void clearIterationCount() { m_iterationCountSet = false; }
  80     void clearName() { m_nameSet = false; }
  81     void clearPlayState() { m_playStateSet = AnimPlayStatePlaying; }
  82     void clearProperty() { m_propertySet = false; }
  83     void clearTimingFunction() { m_timingFunctionSet = false; }
  84
  85     void clearAll()
  86     {
  87         clearDelay();
  88         clearDirection();
  89         clearDuration();
  90         clearFillMode();
  91         clearIterationCount();
  92         clearName();
  93         clearPlayState();
  94         clearProperty();
  95         clearTimingFunction();
  96     }
  97
  98     double delay() const { return m_delay; }
  99
 100     enum AnimationMode {
 101         AnimateAll,
 102         AnimateNone,
 103         AnimateSingleProperty
 104     };
 105
 106     enum AnimationDirection {
 107         AnimationDirectionNormal,
 108         AnimationDirectionAlternate,
 109         AnimationDirectionReverse,
 110         AnimationDirectionAlternateReverse
 111     };
 112     AnimationDirection direction() const { return static_cast<AnimationDirection>(m_direction); }
 113
 114     unsigned fillMode() const { return m_fillMode; }
 115
 116     double duration() const { return m_duration; }
 117
 118     enum { IterationCountInfinite = -1 };
 119     double iterationCount() const { return m_iterationCount; }
 120     const AtomicString& name() const { return m_name; }
 121     EAnimPlayState playState() const { return static_cast<EAnimPlayState>(m_playState); }
 122     CSSPropertyID property() const { return m_property; }
 123     TimingFunction* timingFunction() const { return m_timingFunction.get(); }
 124     AnimationMode animationMode() const { return m_mode; }
 125
 126     void setDelay(double c) { m_delay = c; m_delaySet = true; }
 127     void setDirection(AnimationDirection d) { m_direction = d; m_directionSet = true; }
 128     void setDuration(double d) { ASSERT(d >= 0); m_duration = d; m_durationSet = true; }
 129     void setFillMode(unsigned f) { m_fillMode = f; m_fillModeSet = true; }
 130     void setIterationCount(double c) { m_iterationCount = c; m_iterationCountSet = true; }
 131     void setName(const AtomicString& n) { m_name = n; m_nameSet = true; }
 132     void setPlayState(EAnimPlayState d) { m_playState = d; m_playStateSet = true; }
 133     void setProperty(CSSPropertyID t) { m_property = t; m_propertySet = true; }
 134     void setTimingFunction(PassRefPtr<TimingFunction> f) { m_timingFunction = f; m_timingFunctionSet = true; }
 135     void setAnimationMode(AnimationMode mode) { m_mode = mode; }
 136
 137     void setIsNoneAnimation(bool n) { m_isNone = n; }
 138
 139     CSSAnimationData& operator=(const CSSAnimationData&);
 140
 141     // return true every CSSAnimationData in the chain (defined by m_next) match
 142     bool operator==(const CSSAnimationData& o) const { return animationsMatchForStyleRecalc(&o); }
 143     bool operator!=(const CSSAnimationData& o) const { return !(*this == o); }
 144
 145     void trace(Visitor*) { }
 146
 147 private:
 148     CSSAnimationData();
 149     explicit CSSAnimationData(const CSSAnimationData&);
 150
 151     // Return whether this object matches another CSSAnimationData object for
 152     // the purposes of style recalc. This excludes some properties.
 153     bool animationsMatchForStyleRecalc(const CSSAnimationData*) const;
 154
 155     AtomicString m_name;
 156     CSSPropertyID m_property;
 157     AnimationMode m_mode;
 158     double m_iterationCount;
 159     double m_delay;
 160     double m_duration;
 161     RefPtr<TimingFunction> m_timingFunction;
 162     unsigned m_direction : 2; // AnimationDirection
 163     unsigned m_fillMode : 2;
 164
 165     unsigned m_playState     : 2;
 166
 167     unsigned m_delaySet          : 1;
 168     unsigned m_directionSet      : 1;
 169     unsigned m_durationSet       : 1;
 170     unsigned m_fillModeSet       : 1;
 171     unsigned m_iterationCountSet : 1;
 172     unsigned m_nameSet           : 1;
 173     unsigned m_playStateSet      : 1;
 174     unsigned m_propertySet       : 1;
 175     unsigned m_timingFunctionSet : 1;
 176
 177     unsigned m_isNone            : 1;
 178
 179 public:
 180     static double initialAnimationDelay() { return 0; }
 181     static AnimationDirection initialAnimationDirection() { return AnimationDirectionNormal; }
 182     static double initialAnimationDuration() { return 0; }
 183     static unsigned initialAnimationFillMode() { return AnimationFillModeNone; }
 184     static double initialAnimationIterationCount() { return 1.0; }
 185     static const AtomicString& initialAnimationName();
 186     static EAnimPlayState initialAnimationPlayState() { return AnimPlayStatePlaying; }
 187     static CSSPropertyID initialAnimationProperty() { return CSSPropertyInvalid; }
 188     static const PassRefPtr<TimingFunction> initialAnimationTimingFunction() { return CubicBezierTimingFunction::preset(CubicBezierTimingFunction::Ease); }
 189 };
 190
 191 } // namespace WebCore
 192
 193 #endif // CSSAnimationData_h