Explicit animation support

ui/gfx/compositor/layer_animation_element.h

+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef UI_GFX_COMPOSITOR_LAYER_ANIMATION_ELEMENT_H_
+#define UI_GFX_COMPOSITOR_LAYER_ANIMATION_ELEMENT_H_
+#pragma once
+
+#include <set>
+
+#include "base/time.h"
+#include "ui/gfx/compositor/compositor_export.h"
+
+namespace gfx {
+class Rect;
+}  // gfx
+
+namespace ui {
+
+class LayerAnimationDelegate;
+class Transform;
+
+// LayerAnimationElements represent one segment of an animation between two
+// keyframes. They know how to update a LayerAnimationDelegate given a value
+// between 0 and 1 (0 for initial, and 1 for final).
+class COMPOSITOR_EXPORT LayerAnimationElement {
+ public:
+  enum AnimatableProperty {
+    TRANSFORM = 0,
+    BOUNDS,
+    OPACITY
+  };
+
+  typedef std::set<AnimatableProperty> AnimatableProperties;
+
+  LayerAnimationElement(const AnimatableProperties& properties,
+                        base::TimeDelta duration);
+  virtual ~LayerAnimationElement();
+
+  // Creates an element that transitions to the given transform. The caller owns
+  // the return value.
+  static LayerAnimationElement* CreateTransformElement(
+      const Transform& transform,
+      base::TimeDelta duration);
+
+  // Creates an element that transitions to the given bounds. The caller owns
+  // the return value.
+  static LayerAnimationElement* CreateBoundsElement(
+      const gfx::Rect& bounds,
+      base::TimeDelta duration);
+
+  // Creates an element that transitions to the given opacity. The caller owns
+  // the return value.
+  static LayerAnimationElement* CreateOpacityElement(
+      float opacity,
+      base::TimeDelta duration);
+
+  // Creates an element that pauses the given properties. The caller owns the
+  // return value.
+  static LayerAnimationElement* CreatePauseElement(
+      const AnimatableProperties& properties,
+      base::TimeDelta duration);
+
+  // Updates the delegate to the appropriate value for |t|, which is in the
+  // range [0, 1] (0 for initial, and 1 for final). If the animation is not
+  // aborted, it is guaranteed that Progress will eventually be called with
+  // t = 1.0.
+  void Progress(double t, LayerAnimationDelegate* delegate);
+
+  // Called if the animation is not allowed to complete. This may be called
+  // before OnStarted or Progress.
+  void Abort();
+
+  // The properties that the element modifies.
+  const AnimatableProperties& properties() const { return properties_; }
+
+  // The duration of the animation
+  base::TimeDelta duration() const { return duration_; }
+
+ protected:
+  // Called once each time the animation element is run before any call to
+  // OnProgress.
+  virtual void OnStart(LayerAnimationDelegate* delegate) = 0;
+  virtual void OnProgress(double t, LayerAnimationDelegate* delegate) = 0;
+  virtual void OnAbort() = 0;
+
+ private:
+  bool first_frame_;
+  const AnimatableProperties properties_;
+  const base::TimeDelta duration_;
+
+  DISALLOW_COPY_AND_ASSIGN(LayerAnimationElement);
+};
+
+}  // namespace ui
+
+#endif  // UI_GFX_COMPOSITOR_LAYER_ANIMATION_ELEMENT_H_