Line data    Source code

       1             : /**
       2             :  Copyright (c) 2023 Stappler LLC <admin@stappler.dev>
       3             : 
       4             :  Permission is hereby granted, free of charge, to any person obtaining a copy
       5             :  of this software and associated documentation files (the "Software"), to deal
       6             :  in the Software without restriction, including without limitation the rights
       7             :  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       8             :  copies of the Software, and to permit persons to whom the Software is
       9             :  furnished to do so, subject to the following conditions:
      10             : 
      11             :  The above copyright notice and this permission notice shall be included in
      12             :  all copies or substantial portions of the Software.
      13             : 
      14             :  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      15             :  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      16             :  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      17             :  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      18             :  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      19             :  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      20             :  THE SOFTWARE.
      21             :  **/
      22             : 
      23             : #ifndef XENOLITH_RENDERER_BASIC2D_XL2DSCROLLVIEW_H_
      24             : #define XENOLITH_RENDERER_BASIC2D_XL2DSCROLLVIEW_H_
      25             : 
      26             : #include "XL2dScrollViewBase.h"
      27             : #include "XL2dScrollController.h"
      28             : #include "XL2dVectorSprite.h"
      29             : 
      30             : namespace STAPPLER_VERSIONIZED stappler::xenolith::basic2d {
      31             : 
      32             : class LayerRounded;
      33             : 
      34             : class ScrollView : public ScrollViewBase {
      35             : public:
      36             :         using TapCallback = Function<void(int count, const Vec2 &loc)>;
      37             :         using AnimationCallback = Function<void()>;
      38             : 
      39             :         class Overscroll : public VectorSprite {
      40             :         public:
      41             :                 enum Direction {
      42             :                         Top,
      43             :                         Left,
      44             :                         Bottom,
      45             :                         Right
      46             :                 };
      47             : 
      48             :                 static constexpr float OverscrollEdge = 0.075f;
      49             :                 static constexpr float OverscrollEdgeThreshold = 0.5f;
      50             :                 static constexpr float OverscrollScale = 1.0f / 6.0f;
      51             :                 static constexpr float OverscrollMaxHeight = 64.0f;
      52             : 
      53         184 :                 virtual ~Overscroll() { }
      54             : 
      55             :                 virtual bool init() override;
      56             :                 virtual bool init(Direction);
      57             :                 virtual void onContentSizeDirty() override;
      58             :                 virtual void update(const UpdateTime &time) override;
      59             :                 virtual void onEnter(Scene*) override;
      60             :                 virtual void onExit() override;
      61             : 
      62             :                 virtual void setDirection(Direction);
      63             :                 virtual Direction getDirection() const;
      64             : 
      65             :                 void setProgress(float p);
      66             :                 void incrementProgress(float dt);
      67             :                 void decrementProgress(float dt);
      68             : 
      69             :         protected:
      70             :                 using VectorSprite::init;
      71             : 
      72             :                 void updateProgress(VectorImage *);
      73             : 
      74             :                 bool _progressDirty = false;
      75             :                 float _progress = 0.0f;
      76             :                 uint64_t _delayStart = 0;
      77             :                 Direction _direction = Direction::Top;
      78             :         };
      79             : 
      80          82 :         virtual ~ScrollView() { }
      81             : 
      82             :         virtual bool init(Layout l) override;
      83             : 
      84             :         virtual void onContentSizeDirty() override;
      85             : 
      86             :         virtual void setOverscrollColor(const Color4F &, bool withOpacity = false);
      87             :         virtual Color4F getOverscrollColor() const;
      88             : 
      89             :         virtual void setOverscrollVisible(bool value);
      90             :         virtual bool isOverscrollVisible() const;
      91             : 
      92             :         virtual void setIndicatorColor(const Color4B &, bool withOpacity = false);
      93             :         virtual Color4F getIndicatorColor() const;
      94             : 
      95             :         virtual void setIndicatorVisible(bool value);
      96             :         virtual bool isIndicatorVisible() const;
      97             : 
      98             :         virtual void setPadding(const Padding &) override;
      99             : 
     100             :         virtual void setOverscrollFrontOffset(float value);
     101             :         virtual float getOverscrollFrontOffset() const;
     102             : 
     103             :         virtual void setOverscrollBackOffset(float value);
     104             :         virtual float getOverscrollBackOffset() const;
     105             : 
     106             :         virtual void setIndicatorIgnorePadding(bool value);
     107             :         virtual bool isIndicatorIgnorePadding() const;
     108             : 
     109             :         virtual void setTapCallback(const TapCallback &);
     110             :         virtual const TapCallback &getTapCallback() const;
     111             : 
     112             :         virtual void setAnimationCallback(const AnimationCallback &);
     113             :         virtual const AnimationCallback &getAnimationCallback() const;
     114             : 
     115             :         virtual void update(const UpdateTime &time) override;
     116             : 
     117             :         enum class Adjust {
     118             :                 None,
     119             :                 Front,
     120             :                 Back
     121             :         };
     122             : 
     123             :         virtual void runAdjustPosition(float pos, float factor = 1.0f);
     124             :         virtual void runAdjust(float pos, float factor = 1.0f);
     125             :         virtual void scheduleAdjust(Adjust, float value);
     126             : 
     127             :         virtual Value save() const;
     128             :         virtual void load(const Value &);
     129             : 
     130             : public:
     131             :         virtual Rc<ActionProgress> resizeNode(Node *, float newSize, float duration, Function<void()> &&cb = nullptr);
     132             :         virtual Rc<ActionProgress> resizeNode(ScrollController::Item *, float newSize, float duration, Function<void()> &&cb = nullptr);
     133             : 
     134             :         virtual Rc<ActionProgress> removeNode(Node *, float duration, Function<void()> &&cb = nullptr, bool disable = false);
     135             :         virtual Rc<ActionProgress> removeNode(ScrollController::Item *, float duration, Function<void()> &&cb = nullptr, bool disable = false);
     136             : 
     137             : protected:
     138             :         virtual void doSetScrollPosition(float pos) override;
     139             : 
     140             :         virtual void onOverscroll(float delta) override;
     141             :         virtual void onScroll(float delta, bool finished) override;
     142             :         virtual void onTap(int count, const Vec2 &loc) override;
     143             :         virtual void onAnimationFinished() override;
     144             : 
     145             :         virtual void updateIndicatorPosition();
     146             :         virtual void updateIndicatorPosition(Node *indicator, float size, float value, bool actions, float min);
     147             : 
     148             :         virtual ScrollController::Item * getItemForNode(Node *) const;
     149             : 
     150             :         Overscroll *_overflowFront = nullptr;
     151             :         Overscroll *_overflowBack = nullptr;
     152             : 
     153             :         LayerRounded *_indicator = nullptr;
     154             :         bool _indicatorVisible = true;
     155             :         bool _indicatorIgnorePadding = false;
     156             : 
     157             :         float _overscrollFrontOffset = 0.0f;
     158             :         float _overscrollBackOffset = 0.0f;
     159             : 
     160             :         TapCallback _tapCallback = nullptr;
     161             :         AnimationCallback _animationCallback = nullptr;
     162             : 
     163             :         Adjust _adjust = Adjust::None;
     164             :         float _adjustValue = 0.0f;
     165             :         float _indicatorOpacity = 0.5f;
     166             : };
     167             : 
     168             : }
     169             : 
     170             : #endif /* XENOLITH_RENDERER_BASIC2D_XL2DSCROLLVIEW_H_ */