New in version 1.7.0.
Based on the
kinetic effect, the
will limit the movement to bounds determined by its
max properties. If the movement exceeds these
bounds, it will calculate the amount of
try to return to the value of one of the bounds.
This is very useful for implementing a scrolling list. We actually use this
class as a base effect for our
- class kivy.effects.scroll.ScrollEffect(**kwargs)¶
ScrollEffect class. See the module documentation for more information.
Cumulative distance of the movement during the interaction. This is used to determine if the movement is a drag (more than
drag_threshold) or not.
Minimum distance to travel before the movement is considered as a drag.
Computed value when the user over-scrolls i.e. goes out of the bounds.
(internal) Reset the value and the velocity to the pos. Mostly used when the bounds are checked.
Computed value for scrolling. This value is different from
kivy.effects.kinetic.KineticEffect.valuein that it will return to one of the min/max bounds.
- start(val, t=None)¶
Start the movement.
- val: float or int
Value of the movement
- t: float, defaults to None
Time when the movement happen. If no time is set, it will use time.time()
Widget to attach to this effect. Even if this class doesn’t make changes to the target_widget by default, subclasses can use it to change the graphics or apply custom transformations.