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 "wtf/PassRefPtr.h"
  32 #include "wtf/RefCounted.h"
  33 #include "wtf/text/WTFString.h"
  34
  35 namespace WebCore {
  36
  37 class CSSAnimationData : public RefCounted<CSSAnimationData> {
  38 public:
  39     ~CSSAnimationData();
  40
  41     static PassRefPtr<CSSAnimationData> create() { return adoptRef(new CSSAnimationData); }
  42     static PassRefPtr<CSSAnimationData> create(const CSSAnimationData* o) { return adoptRef(new CSSAnimationData(*o)); }
  43
  44     bool isDelaySet() const { return m_delaySet; }
  45     bool isDirectionSet() const { return m_directionSet; }
  46     bool isDurationSet() const { return m_durationSet; }
  47     bool isFillModeSet() const { return m_fillModeSet; }
  48     bool isIterationCountSet() const { return m_iterationCountSet; }
  49     bool isNameSet() const { return m_nameSet; }
  50     bool isPlayStateSet() const { return m_playStateSet; }
  51     bool isPropertySet() const { return m_propertySet; }
  52     bool isTimingFunctionSet() const { return m_timingFunctionSet; }
  53
  54     // Flags this to be the special "none" animation (animation-name: none)
  55     bool isNoneAnimation() const { return m_isNone; }
  56     // We can make placeholder CSSAnimationData objects to keep the comma-separated lists
  57     // of properties in sync. isValidAnimation means this is not a placeholder.
  58     bool isValidAnimation() const { return !m_isNone && !m_name.isEmpty(); }
  59
  60     bool isEmpty() const
  61     {
  62         return (!m_directionSet && !m_durationSet && !m_fillModeSet
  63                 && !m_nameSet && !m_playStateSet && !m_iterationCountSet
  64                 && !m_delaySet && !m_timingFunctionSet && !m_propertySet);
  65     }
  66
  67     void clearDelay() { m_delaySet = false; }
  68     void clearDirection() { m_directionSet = false; }
  69     void clearDuration() { m_durationSet = false; }
  70     void clearFillMode() { m_fillModeSet = false; }
  71     void clearIterationCount() { m_iterationCountSet = false; }
  72     void clearName() { m_nameSet = false; }
  73     void clearPlayState() { m_playStateSet = AnimPlayStatePlaying; }
  74     void clearProperty() { m_propertySet = false; }
  75     void clearTimingFunction() { m_timingFunctionSet = false; }
  76
  77     void clearAll()
  78     {
  79         clearDelay();
  80         clearDirection();
  81         clearDuration();
  82         clearFillMode();
  83         clearIterationCount();
  84         clearName();
  85         clearPlayState();
  86         clearProperty();
  87         clearTimingFunction();
  88     }
  89
  90     double delay() const { return m_delay; }
  91
  92     enum AnimationMode {
  93         AnimateAll,
  94         AnimateNone,
  95         AnimateSingleProperty
  96     };
  97
  98     enum AnimationDirection {
  99         AnimationDirectionNormal,
 100         AnimationDirectionAlternate,
 101         AnimationDirectionReverse,
 102         AnimationDirectionAlternateReverse
 103     };
 104     AnimationDirection direction() const { return static_cast<AnimationDirection>(m_direction); }
 105
 106     unsigned fillMode() const { return m_fillMode; }
 107
 108     double duration() const { return m_duration; }
 109
 110     enum { IterationCountInfinite = -1 };
 111     double iterationCount() const { return m_iterationCount; }
 112     const AtomicString& name() const { return m_name; }
 113     EAnimPlayState playState() const { return static_cast<EAnimPlayState>(m_playState); }
 114     CSSPropertyID property() const { return m_property; }
 115     TimingFunction* timingFunction() const { return m_timingFunction.get(); }
 116     AnimationMode animationMode() const { return m_mode; }
 117
 118     void setDelay(double c) { m_delay = c; m_delaySet = true; }
 119     void setDirection(AnimationDirection d) { m_direction = d; m_directionSet = true; }
 120     void setDuration(double d) { ASSERT(d >= 0); m_duration = d; m_durationSet = true; }
 121     void setFillMode(unsigned f) { m_fillMode = f; m_fillModeSet = true; }
 122     void setIterationCount(double c) { m_iterationCount = c; m_iterationCountSet = true; }
 123     void setName(const AtomicString& n) { m_name = n; m_nameSet = true; }
 124     void setPlayState(EAnimPlayState d) { m_playState = d; m_playStateSet = true; }
 125     void setProperty(CSSPropertyID t) { m_property = t; m_propertySet = true; }
 126     void setTimingFunction(PassRefPtr<TimingFunction> f) { m_timingFunction = f; m_timingFunctionSet = true; }
 127     void setAnimationMode(AnimationMode mode) { m_mode = mode; }
 128
 129     void setIsNoneAnimation(bool n) { m_isNone = n; }
 130
 131     CSSAnimationData& operator=(const CSSAnimationData&);
 132
 133     // return true every CSSAnimationData in the chain (defined by m_next) match
 134     bool operator==(const CSSAnimationData& o) const { return animationsMatchForStyleRecalc(&o); }
 135     bool operator!=(const CSSAnimationData& o) const { return !(*this == o); }
 136
 137 private:
 138     CSSAnimationData();
 139     explicit CSSAnimationData(const CSSAnimationData&);
 140
 141     // Return whether this object matches another CSSAnimationData object for
 142     // the purposes of style recalc. This excludes some properties.
 143     bool animationsMatchForStyleRecalc(const CSSAnimationData*) const;
 144
 145     AtomicString m_name;
 146     CSSPropertyID m_property;
 147     AnimationMode m_mode;
 148     double m_iterationCount;
 149     double m_delay;
 150     double m_duration;
 151     RefPtr<TimingFunction> m_timingFunction;
 152     unsigned m_direction : 2; // AnimationDirection
 153     unsigned m_fillMode : 2;
 154
 155     unsigned m_playState     : 2;
 156
 157     unsigned m_delaySet          : 1;
 158     unsigned m_directionSet      : 1;
 159     unsigned m_durationSet       : 1;
 160     unsigned m_fillModeSet       : 1;
 161     unsigned m_iterationCountSet : 1;
 162     unsigned m_nameSet           : 1;
 163     unsigned m_playStateSet      : 1;
 164     unsigned m_propertySet       : 1;
 165     unsigned m_timingFunctionSet : 1;
 166
 167     unsigned m_isNone            : 1;
 168
 169 public:
 170     static double initialAnimationDelay() { return 0; }
 171     static AnimationDirection initialAnimationDirection() { return AnimationDirectionNormal; }
 172     static double initialAnimationDuration() { return 0; }
 173     static unsigned initialAnimationFillMode() { return AnimationFillModeNone; }
 174     static double initialAnimationIterationCount() { return 1.0; }
 175     static const AtomicString& initialAnimationName();
 176     static EAnimPlayState initialAnimationPlayState() { return AnimPlayStatePlaying; }
 177     static CSSPropertyID initialAnimationProperty() { return CSSPropertyInvalid; }
 178     static const PassRefPtr<TimingFunction> initialAnimationTimingFunction() { return CubicBezierTimingFunction::preset(CubicBezierTimingFunction::Ease); }
 179 };
 180
 181 } // namespace WebCore
 182
 183 #endif // CSSAnimationData_h