File: ScrollAnimatorBase.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (121 lines) | stat: -rw-r--r-- 4,772 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
 * Copyright (c) 2010, Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ScrollAnimatorBase_h
#define ScrollAnimatorBase_h

#include "platform/PlatformExport.h"
#include "platform/heap/Handle.h"
#include "platform/scroll/ScrollAnimatorCompositorCoordinator.h"
#include "platform/scroll/ScrollTypes.h"
#include "wtf/Forward.h"

namespace blink {

class CompositorAnimationTimeline;
class ScrollableArea;
class Scrollbar;

class PLATFORM_EXPORT ScrollAnimatorBase
    : public ScrollAnimatorCompositorCoordinator {
 public:
  static ScrollAnimatorBase* create(ScrollableArea*);

  virtual ~ScrollAnimatorBase();

  virtual void dispose() {}

  // A possibly animated scroll. The base class implementation always scrolls
  // immediately, never animates. If the scroll is animated and currently the
  // animator has an in-progress animation, the ScrollResult will always return
  // no unusedDelta and didScroll=true, i.e. fully consuming the scroll request.
  // This makes animations latch to a single scroller. Note, the semantics are
  // currently somewhat different on Mac - see ScrollAnimatorMac.mm.
  virtual ScrollResult userScroll(ScrollGranularity, const ScrollOffset& delta);

  virtual void scrollToOffsetWithoutAnimation(const ScrollOffset&);

  void setCurrentOffset(const ScrollOffset&);
  ScrollOffset currentOffset() const;
  virtual ScrollOffset desiredTargetOffset() const { return currentOffset(); }

  // Returns how much of pixelDelta will be used by the underlying scrollable
  // area.
  virtual ScrollOffset computeDeltaToConsume(const ScrollOffset& delta) const;

  // ScrollAnimatorCompositorCoordinator implementation.
  ScrollableArea* getScrollableArea() const override {
    return m_scrollableArea;
  }
  void tickAnimation(double monotonicTime) override{};
  void cancelAnimation() override {}
  void takeOverCompositorAnimation() override {}
  void updateCompositorAnimations() override{};
  void notifyCompositorAnimationFinished(int groupId) override{};
  void notifyCompositorAnimationAborted(int groupId) override{};
  void layerForCompositedScrollingDidChange(
      CompositorAnimationTimeline*) override{};

  virtual void contentAreaWillPaint() const {}
  virtual void mouseEnteredContentArea() const {}
  virtual void mouseExitedContentArea() const {}
  virtual void mouseMovedInContentArea() const {}
  virtual void mouseEnteredScrollbar(Scrollbar&) const {}
  virtual void mouseExitedScrollbar(Scrollbar&) const {}
  virtual void contentsResized() const {}
  virtual void contentAreaDidShow() const {}
  virtual void contentAreaDidHide() const {}

  virtual void finishCurrentScrollAnimations() {}

  virtual void didAddVerticalScrollbar(Scrollbar&) {}
  virtual void willRemoveVerticalScrollbar(Scrollbar&) {}
  virtual void didAddHorizontalScrollbar(Scrollbar&) {}
  virtual void willRemoveHorizontalScrollbar(Scrollbar&) {}

  virtual void notifyContentAreaScrolled(const ScrollOffset&) {}

  virtual bool setScrollbarsVisibleForTesting(bool) { return false; }

  DECLARE_VIRTUAL_TRACE();

 protected:
  explicit ScrollAnimatorBase(ScrollableArea*);

  virtual void notifyOffsetChanged();

  Member<ScrollableArea> m_scrollableArea;

  ScrollOffset m_currentOffset;
};

}  // namespace blink

#endif  // ScrollAnimatorBase_h