src/third_party/WebKit/public/platform/WebAnimation.h

   1 /*
   2  * Copyright (C) 2012 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
   6  * are met:
   7  * 1.  Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef WebAnimation_h
  26 #define WebAnimation_h
  27
  28 #include "WebCommon.h"
  29 #include "WebNonCopyable.h"
  30 #include "WebPrivateOwnPtr.h"
  31
  32 #if BLINK_IMPLEMENTATION
  33 #include "wtf/Forward.h"
  34 #endif
  35
  36 #define WebCompositorAnimation WebAnimation
  37
  38 namespace blink {
  39 class CCActiveAnimation;
  40 }
  41
  42 namespace blink {
  43
  44 class WebAnimationCurve;
  45
  46 // A compositor driven animation.
  47 class WebAnimation {
  48 public:
  49     enum TargetProperty {
  50         TargetPropertyTransform = 0,
  51         TargetPropertyOpacity,
  52         TargetPropertyFilter,
  53         TargetPropertyScrollOffset
  54     };
  55
  56     virtual ~WebAnimation() { }
  57
  58     // An id is effectively the animation's name, and it is not unique.
  59     virtual int id() = 0;
  60
  61     virtual TargetProperty targetProperty() const = 0;
  62
  63     // This is the number of times that the animation will play. If this
  64     // value is zero the animation will not play. If it is negative, then
  65     // the animation will loop indefinitely.
  66     virtual int iterations() const = 0;
  67     virtual void setIterations(int) = 0;
  68
  69     virtual double startTime() const = 0;
  70     virtual void setStartTime(double monotonicTime) = 0;
  71
  72     virtual double timeOffset() const = 0;
  73     virtual void setTimeOffset(double monotonicTime) = 0;
  74
  75     // If alternatesDirection is true, on odd numbered iterations we reverse the curve.
  76     virtual bool alternatesDirection() const = 0;
  77     virtual void setAlternatesDirection(bool) = 0;
  78 };
  79
  80 } // namespace blink
  81
  82 #endif // WebAnimation_h