interpolated_transform.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. // Copyright (c) 2012 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #ifndef UI_GFX_INTERPOLATED_TRANSFORM_H_
  5. #define UI_GFX_INTERPOLATED_TRANSFORM_H_
  6. #include <memory>
  7. #include "ui/gfx/geometry/point.h"
  8. #include "ui/gfx/geometry/point3_f.h"
  9. #include "ui/gfx/geometry/transform.h"
  10. #include "ui/gfx/geometry/transform_util.h"
  11. #include "ui/gfx/geometry/vector3d_f.h"
  12. #include "ui/gfx/gfx_export.h"
  13. namespace ui {
  14. ///////////////////////////////////////////////////////////////////////////////
  15. // class InterpolatedTransform
  16. //
  17. // Abstract base class for transforms that animate over time. These
  18. // interpolated transforms can be combined to allow for more sophisticated
  19. // animations. For example, you might combine a rotation of 90 degrees between
  20. // times 0 and 1, with a scale from 1 to 0.3 between times 0 and 0.25 and a
  21. // scale from 0.3 to 1 from between times 0.75 and 1.
  22. //
  23. ///////////////////////////////////////////////////////////////////////////////
  24. class GFX_EXPORT InterpolatedTransform {
  25. public:
  26. InterpolatedTransform();
  27. // The interpolated transform varies only when t in (start_time, end_time).
  28. // If t <= start_time, Interpolate(t) will return the initial transform, and
  29. // if t >= end_time, Interpolate(t) will return the final transform.
  30. InterpolatedTransform(float start_time, float end_time);
  31. InterpolatedTransform(const InterpolatedTransform&) = delete;
  32. InterpolatedTransform& operator=(const InterpolatedTransform&) = delete;
  33. virtual ~InterpolatedTransform();
  34. // Returns the interpolated transform at time t. Note: not virtual.
  35. gfx::Transform Interpolate(float t) const;
  36. // The Intepolate ultimately returns the product of our transform at time t
  37. // and our child's transform at time t (if we have one).
  38. //
  39. // This function takes ownership of the passed InterpolatedTransform.
  40. void SetChild(std::unique_ptr<InterpolatedTransform> child);
  41. // If the interpolated transform is reversed, Interpolate(t) will return
  42. // Interpolate(1 - t)
  43. void SetReversed(bool reversed) { reversed_ = reversed; }
  44. bool Reversed() const { return reversed_; }
  45. protected:
  46. // Calculates the interpolated transform without considering our child.
  47. virtual gfx::Transform InterpolateButDoNotCompose(float t) const = 0;
  48. // If time in (start_time_, end_time_], this function linearly interpolates
  49. // between start_value and end_value. More precisely it returns
  50. // (1 - t) * start_value + t * end_value where
  51. // t = (start_time_ - time) / (end_time_ - start_time_).
  52. // If time < start_time_ it returns start_value, and if time >= end_time_
  53. // it returns end_value.
  54. float ValueBetween(float time, float start_value, float end_value) const;
  55. float start_time() const { return start_time_; }
  56. float end_time() const { return end_time_; }
  57. private:
  58. const float start_time_;
  59. const float end_time_;
  60. // The child transform. If you consider an interpolated transform as a
  61. // function of t. If, without a child, we are f(t), and our child is
  62. // g(t), then with a child we become f'(t) = f(t) * g(t). Using a child
  63. // transform, we can chain collections of transforms together.
  64. std::unique_ptr<InterpolatedTransform> child_;
  65. bool reversed_;
  66. };
  67. ///////////////////////////////////////////////////////////////////////////////
  68. // class InterpolatedRotation
  69. //
  70. // Represents an animated rotation.
  71. //
  72. ///////////////////////////////////////////////////////////////////////////////
  73. class GFX_EXPORT InterpolatedRotation : public InterpolatedTransform {
  74. public:
  75. InterpolatedRotation(float start_degrees, float end_degrees);
  76. InterpolatedRotation(float start_degrees,
  77. float end_degrees,
  78. float start_time,
  79. float end_time);
  80. InterpolatedRotation(const InterpolatedRotation&) = delete;
  81. InterpolatedRotation& operator=(const InterpolatedRotation&) = delete;
  82. ~InterpolatedRotation() override;
  83. protected:
  84. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  85. private:
  86. const float start_degrees_;
  87. const float end_degrees_;
  88. };
  89. ///////////////////////////////////////////////////////////////////////////////
  90. // class InterpolatedAxisAngleRotation
  91. //
  92. // Represents an animated rotation.
  93. //
  94. ///////////////////////////////////////////////////////////////////////////////
  95. class GFX_EXPORT InterpolatedAxisAngleRotation : public InterpolatedTransform {
  96. public:
  97. InterpolatedAxisAngleRotation(const gfx::Vector3dF& axis,
  98. float start_degrees,
  99. float end_degrees);
  100. InterpolatedAxisAngleRotation(const gfx::Vector3dF& axis,
  101. float start_degrees,
  102. float end_degrees,
  103. float start_time,
  104. float end_time);
  105. InterpolatedAxisAngleRotation(const InterpolatedAxisAngleRotation&) = delete;
  106. InterpolatedAxisAngleRotation& operator=(
  107. const InterpolatedAxisAngleRotation&) = delete;
  108. ~InterpolatedAxisAngleRotation() override;
  109. protected:
  110. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  111. private:
  112. gfx::Vector3dF axis_;
  113. const float start_degrees_;
  114. const float end_degrees_;
  115. };
  116. ///////////////////////////////////////////////////////////////////////////////
  117. // class InterpolatedScale
  118. //
  119. // Represents an animated scale.
  120. //
  121. ///////////////////////////////////////////////////////////////////////////////
  122. class GFX_EXPORT InterpolatedScale : public InterpolatedTransform {
  123. public:
  124. InterpolatedScale(float start_scale, float end_scale);
  125. InterpolatedScale(float start_scale, float end_scale,
  126. float start_time, float end_time);
  127. InterpolatedScale(const gfx::Point3F& start_scale,
  128. const gfx::Point3F& end_scale);
  129. InterpolatedScale(const gfx::Point3F& start_scale,
  130. const gfx::Point3F& end_scale,
  131. float start_time,
  132. float end_time);
  133. InterpolatedScale(const InterpolatedScale&) = delete;
  134. InterpolatedScale& operator=(const InterpolatedScale&) = delete;
  135. ~InterpolatedScale() override;
  136. protected:
  137. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  138. private:
  139. const gfx::Point3F start_scale_;
  140. const gfx::Point3F end_scale_;
  141. };
  142. class GFX_EXPORT InterpolatedTranslation : public InterpolatedTransform {
  143. public:
  144. InterpolatedTranslation(const gfx::PointF& start_pos,
  145. const gfx::PointF& end_pos);
  146. InterpolatedTranslation(const gfx::PointF& start_pos,
  147. const gfx::PointF& end_pos,
  148. float start_time,
  149. float end_time);
  150. InterpolatedTranslation(const gfx::Point3F& start_pos,
  151. const gfx::Point3F& end_pos);
  152. InterpolatedTranslation(const gfx::Point3F& start_pos,
  153. const gfx::Point3F& end_pos,
  154. float start_time,
  155. float end_time);
  156. InterpolatedTranslation(const InterpolatedTranslation&) = delete;
  157. InterpolatedTranslation& operator=(const InterpolatedTranslation&) = delete;
  158. ~InterpolatedTranslation() override;
  159. protected:
  160. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  161. private:
  162. const gfx::Point3F start_pos_;
  163. const gfx::Point3F end_pos_;
  164. };
  165. ///////////////////////////////////////////////////////////////////////////////
  166. // class InterpolatedConstantTransform
  167. //
  168. // Represents a transform that is constant over time. This is only useful when
  169. // composed with other interpolated transforms.
  170. //
  171. // See InterpolatedTransformAboutPivot for an example of its usage.
  172. //
  173. ///////////////////////////////////////////////////////////////////////////////
  174. class GFX_EXPORT InterpolatedConstantTransform : public InterpolatedTransform {
  175. public:
  176. explicit InterpolatedConstantTransform(const gfx::Transform& transform);
  177. InterpolatedConstantTransform(const InterpolatedConstantTransform&) = delete;
  178. InterpolatedConstantTransform& operator=(
  179. const InterpolatedConstantTransform&) = delete;
  180. ~InterpolatedConstantTransform() override;
  181. protected:
  182. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  183. private:
  184. const gfx::Transform transform_;
  185. };
  186. ///////////////////////////////////////////////////////////////////////////////
  187. // class InterpolatedTransformAboutPivot
  188. //
  189. // Represents an animated transform with a transformed origin. Essentially,
  190. // at each time, t, the interpolated transform is created by composing
  191. // P * T * P^-1 where P is a constant transform to the new origin.
  192. //
  193. ///////////////////////////////////////////////////////////////////////////////
  194. class GFX_EXPORT InterpolatedTransformAboutPivot
  195. : public InterpolatedTransform {
  196. public:
  197. // Takes ownership of the passed transform.
  198. InterpolatedTransformAboutPivot(
  199. const gfx::Point& pivot,
  200. std::unique_ptr<InterpolatedTransform> transform);
  201. // Takes ownership of the passed transform.
  202. InterpolatedTransformAboutPivot(
  203. const gfx::Point& pivot,
  204. std::unique_ptr<InterpolatedTransform> transform,
  205. float start_time,
  206. float end_time);
  207. InterpolatedTransformAboutPivot(const InterpolatedTransformAboutPivot&) =
  208. delete;
  209. InterpolatedTransformAboutPivot& operator=(
  210. const InterpolatedTransformAboutPivot&) = delete;
  211. ~InterpolatedTransformAboutPivot() override;
  212. protected:
  213. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  214. private:
  215. void Init(const gfx::Point& pivot,
  216. std::unique_ptr<InterpolatedTransform> transform);
  217. std::unique_ptr<InterpolatedTransform> transform_;
  218. };
  219. class GFX_EXPORT InterpolatedMatrixTransform : public InterpolatedTransform {
  220. public:
  221. InterpolatedMatrixTransform(const gfx::Transform& start_transform,
  222. const gfx::Transform& end_transform);
  223. InterpolatedMatrixTransform(const gfx::Transform& start_transform,
  224. const gfx::Transform& end_transform,
  225. float start_time,
  226. float end_time);
  227. ~InterpolatedMatrixTransform() override;
  228. protected:
  229. gfx::Transform InterpolateButDoNotCompose(float t) const override;
  230. private:
  231. void Init(const gfx::Transform& start_transform,
  232. const gfx::Transform& end_transform);
  233. gfx::DecomposedTransform start_decomp_;
  234. gfx::DecomposedTransform end_decomp_;
  235. };
  236. } // namespace ui
  237. #endif // UI_GFX_INTERPOLATED_TRANSFORM_H_