Kanzi  3.9.4
Kanzi Engine API
kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

Implementation class for ScrollViewConcept. More...

#include <kanzi/ui/node/concept/scroll_view.hpp>

Inheritance diagram for kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >:
[legend]

Public Types

typedef ScrollViewConceptImpl< TBaseClass, TDerivedClass > TScrollView
 
- Public Types inherited from kanzi::ScrollViewConcept
enum  AllowedScrollAxis { XAxis, YAxis, AllAxes }
 Enumeration for AllowedScrollAxisProperty which sets the axis on which you want to allow a Scroll View node to scroll. More...
 
enum  PanState { PanInitial, PanStarted, PanCancelling, PanCanceled }
 Enumeration for the state of pan. More...
 
enum  ScrollDirection { ScrollUp, ScrollDown, ScrollLeft, ScrollRight }
 Enumeration for the available directions when scrolling by step. More...
 
enum  ScrollEdge { ScrollHome, ScrollEnd }
 Enumeration for the available directions when scrolling to the edge of a Scroll View. More...
 
enum  ScrollPage { ScrollPageUp, ScrollPageDown }
 Enumeration for the available directions when scrolling a Scroll View node by page. More...
 

Public Member Functions

void enableKeyNavigation (bool enabled)
 Enables directional keyboard navigation on the Scroll View. More...
 
AllowedScrollAxis getAllowedScrollAxis () const
 Returns the value of the AllowedScrollAxisProperty. More...
 
float getDraggingAccelerationCoefficient () const
 Gets the value of the DraggingAccelerationCoefficientProperty. More...
 
float getDraggingDragCoefficient () const
 Gets the value of the DraggingDragCoefficientProperty. More...
 
float getDraggingImpulseFactor () const
 Gets the value of the DraggingImpulseFactorProperty. More...
 
int getMaximumNumberOfTouches () const
 Gets the value of the MaximumNumberOfTouchesProperty. More...
 
int getMinimumNumberOfTouches () const
 Gets the value of the MinimumNumberOfTouchesProperty. More...
 
PanManipulatorSharedPtr getPanManipulator () const
 Returns the pan manipulator. More...
 
float getRecognitionThreshold () const
 Gets the value of the RecognitionThresholdProperty. More...
 
Vector2 getScroll () const
 Gets the values of the current scroll position of a Scroll View. More...
 
Vector2 getScrollBoundsMaximum () const
 Gets the value of the ScrollBoundsMaximumProperty. More...
 
Vector2 getScrollBoundsMinimum () const
 Gets the value of the ScrollBoundsMinimumProperty. More...
 
Vector2 getScrollPosition () const
 Gets the value of the ScrollPositionProperty. More...
 
Vector2 getScrollSpeed () const
 Gets the value of the ScrollSpeedProperty. More...
 
Vector2 getScrollTarget () const
 Gets the values of the scroll position of a Scroll View to which the Scroll View is scrolling. More...
 
Vector2 getScrollTargetLooping () const
 When you enable looping, returns the scroll position value normalized to the allowed range of a Scroll View. More...
 
Vector2 getScrollTargetPosition () const
 Gets the value of the ScrollTargetPositionProperty. More...
 
float getSensitivity () const
 Gets the value of the SensitivityProperty. More...
 
float getSlidingAccelerationCoefficient () const
 Gets the value of the SlidingAccelerationCoefficientProperty. More...
 
float getSlidingDragCoefficient () const
 Gets the value of the SlidingDragCoefficientProperty. More...
 
Vector2 getSpeed () const
 Queries the interpolator for the current speed. More...
 
float getStepMultiplier () const
 Gets the value of the StepMultiplierProperty. More...
 
float getSwipeDistance () const
 Gets the value of the SwipeDistanceProperty. More...
 
float getZoom () const
 Gets the value of the ZoomProperty. More...
 
float getZoomMaximum () const
 Gets the value of the ZoomMaximumProperty. More...
 
float getZoomMinimum () const
 Gets the value of the ZoomMinimumProperty. More...
 
bool isDragging () const
 Checks whether a finger is on the surface. More...
 
bool isLoopingXEnabled () const
 Gets the value of the LoopingXEnabledProperty. More...
 
bool isLoopingYEnabled () const
 Gets the value of the LoopingYEnabledProperty. More...
 
bool isScrolling () const
 Gets the value of the ScrollingProperty. More...
 
bool isZoomAffectsScrolling () const
 Gets the value of the ZoomAffectsScrollingProperty. More...
 
bool isZoomEnabled () const
 Gets the value of the ZoomEnabledProperty. More...
 
void jumpToPosition (Vector2 scrollPosition)
 Sets the value for a scroll position within a Scroll View and goes to that position immediatelly without scrolling. More...
 
void refreshThreshold ()
 Updates the recognition threshold of the pan manipulator to the value of the RecognitionThresholdProperty value. More...
 
void scroll (ScrollDirection direction)
 Sets the scroll delta to one step and starts scrolling in that direction. More...
 
void scroll (ScrollPage direction)
 Sets the scroll delta to one distance of the layout height of a Scroll View and starts scrolling in that direction. More...
 
void scroll (ScrollEdge direction)
 Sets the scroll target to the edge defined by the scroll bounds and starts scrolling in that direction. More...
 
void scrollToPosition (Vector2 scrollPosition)
 Sets the value for the scroll position within a Scroll View and starts scrolling to that value. More...
 
void scrollToPositionLooping (Vector2 scrollPosition)
 If you enabled the axis looping for a Scroll View, Kanzi uses the shortest path to the target value. More...
 
void setAllowedScrollAxis (AllowedScrollAxis axis)
 Sets the value of the AllowedScrollAxisProperty. More...
 
void setDraggingAccelerationCoefficient (float value)
 Sets the value of the DraggingAccelerationCoefficientProperty. More...
 
void setDraggingDragCoefficient (float value)
 Sets the value of the DraggingDragCoefficientProperty. More...
 
void setDraggingImpulseFactor (float value)
 Sets the value of the DraggingImpulseFactorProperty. More...
 
void setLoopingXEnabled (bool value)
 Sets the value of the LoopingXEnabledProperty. More...
 
void setLoopingYEnabled (bool value)
 Sets the value of the LoopingYEnabledProperty. More...
 
void setMaximumNumberOfTouches (int value)
 Sets the value of the MaximumNumberOfTouchesProperty. More...
 
void setMinimumNumberOfTouches (int value)
 Sets the value of the MinimumNumberOfTouchesProperty. More...
 
void setRecognitionThreshold (float value)
 Sets the value of the RecognitionThresholdProperty. More...
 
void setScrollBoundsMaximum (Vector2 value)
 Sets the value of the ScrollBoundsMaximumProperty. More...
 
void setScrollBoundsMinimum (Vector2 value)
 Sets the value of the ScrollBoundsMinimumProperty. More...
 
void setScrollBoundsX (float minimum, float maximum)
 Sets the bounds on the x axis. More...
 
void setScrollBoundsY (float minimum, float maximum)
 Sets the bounds on the y axis. More...
 
void setScrolling (bool value)
 Sets the value of the ScrollingProperty. More...
 
void setScrollPosition (Vector2 value)
 Sets the value of the ScrollPositionProperty. More...
 
void setScrollSpeed (Vector2 value)
 Sets the value of the ScrollSpeedProperty. More...
 
void setScrollTargetPosition (Vector2 value)
 Sets the value of the ScrollTargetPositionProperty. More...
 
void setSensitivity (float value)
 Sets the value of the SensitivityProperty. More...
 
void setSlidingAccelerationCoefficient (float value)
 Sets the value of the SlidingAccelerationCoefficientProperty. More...
 
void setSlidingDragCoefficient (float value)
 Sets the value of the SlidingDragCoefficientProperty. More...
 
void setStepMultiplier (float value)
 Sets the value of the StepMultiplierProperty. More...
 
void setSwipeDistance (float value)
 Sets the value of the SwipeDistanceProperty. More...
 
void setZoom (float value)
 Sets the value of the ZoomProperty. More...
 
void setZoomAffectsScrolling (bool value)
 Sets the value of the ZoomAffectsScrollingProperty. More...
 
void setZoomEnabled (bool value)
 Sets the value of the ZoomEnabledProperty. More...
 
void setZoomMaximum (float value)
 Sets the value of the ZoomMaximumProperty. More...
 
void setZoomMinimum (float value)
 Sets the value of the ZoomMinimumProperty. More...
 
 ~ScrollViewConceptImpl () override
 Destructor. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ScrollViewConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

TDerivedClass * getThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const TDerivedClass * getThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
void initialize ()
 Assigns the message handlers for the pan manipulator and scroll messages. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged() implementation. More...
 
void refreshMaximumNumberOfTouches ()
 Kanzi internally updates the maximum number of touch points of the pan manipulator to the value of the MaximumNumberOfTouchesProperty value. More...
 
void refreshMinimumNumberOfTouches ()
 Kanzi internally uses this helper function to update the minimum number of touch points of the pan manipulator to the value of the MinimumNumberOfTouchesProperty value. More...
 
void refreshScrollConfiguration ()
 Kanzi internally uses this helper function to update smooth interpolation coefficients between starting and stopping the interpolator timer, depending on whether a finger is still on a Scroll View node. More...
 
 ScrollViewConceptImpl (Domain *domain, string_view name)
 

Additional Inherited Members

- Static Public Attributes inherited from kanzi::ScrollViewConcept
static MessageType< ScrollDirectionMessageArgumentsScrollDirectionMessage
 Send this message to a Scroll View node to scroll one step in a given direction. More...
 
static MessageType< ScrollDownMessageArgumentsScrollDownMessage
 Send this message to a Scroll View node to scroll down the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< ScrollEdgeMessageArgumentsScrollEdgeMessage
 Send this message to a Scroll View node to scroll to the top or bottom of that Scroll View node. More...
 
static MessageType< ScrolledMessageArgumentsScrolledMessage
 Scroll View sends this message whenever the Scroll View node scrolls. More...
 
static MessageType< ScrollEndMessageArgumentsScrollEndMessage
 Send this message to a Scroll View node to scroll to the end of that Scroll View node. More...
 
static MessageType< ScrollFinishedMessageArgumentsScrollFinishedMessage
 Scroll View sends this message when scrolling ends, regardless of how the scrolling ended. More...
 
static MessageType< ScrollHomeMessageArgumentsScrollHomeMessage
 Send this message to a Scroll View node to scroll to the beginning of that Scroll View node. More...
 
static MessageType< ScrollLeftMessageArgumentsScrollLeftMessage
 Send this message to a Scroll View node to scroll left the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< ScrollPageDownMessageArgumentsScrollPageDownMessage
 Send this message to a Scroll View node to scroll down the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollPageMessageArgumentsScrollPageMessage
 Send this message to a Scroll View node to scroll the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollPageUpMessageArgumentsScrollPageUpMessage
 Send this message to a Scroll View node to scroll up the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollRightMessageArgumentsScrollRightMessage
 Send this message to a Scroll View node to scroll right the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< ScrollStartedMessageArgumentsScrollStartedMessage
 Scroll View sends this message when scrolling starts, regardless of how the scrolling started. More...
 
static MessageType< ScrollUpMessageArgumentsScrollUpMessage
 Send this message to a Scroll View node to scroll up the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< SetScrollMessageArgumentsSetScrollMessage
 Send this message to a Scroll View to go a scroll position immediatelly without scrolling. More...
 
static MessageType< SetScrollTargetMessageArgumentsSetScrollTargetMessage
 Send this message to a Scroll View to scroll to a specific position in that Scroll View node. More...
 
static MessageType< SnapRequestMessageArgumentsSnapRequestMessage
 Scroll View sends this message when scrolling stops, but the Scroll View node needs to snap to the nearest item. More...
 
static MessageType< UserScrollFinishedMessageArgumentsUserScrollFinishedMessage
 Scroll View sends this message when user interaction causes the scrolling to end. More...
 
static MessageType< UserScrollStartedMessageArgumentsUserScrollStartedMessage
 Scroll View sends this message when user interaction causes the scrolling to start. More...
 
static MessageType< ZoomedMessageArgumentsZoomedMessage
 Scroll View sends this message when zoom in or zoom out occurs. More...
 
static PropertyType< float > MessageArgumentScrollViewScrollPositionXProperty
 Use the MessageArgumentScrollViewScrollPositionX argument to set the x axis coordinate for the new scroll position of a Scroll View node. More...
 
static PropertyType< float > MessageArgumentScrollViewScrollPositionYProperty
 Use the MessageArgumentScrollViewScrollPositionY argument to set the y axis coordinate for the new scroll position of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollPositionProperty
 Use the MessageArgumentScrollViewScrollPosition argument to set the x and y axis coordinates for the new scroll position of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollSpeedProperty
 Use the MessageArgumentScrollViewScrollSpeed argument to set the scrolling speed of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollTargetProperty
 Use the MessageArgumentScrollViewScrollTarget argument to set the scroll target for a Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollDirectionProperty
 Use the MessageArgumentScrollViewScrollDirection argument to set the scrolling direction for a Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollPageProperty
 Use the MessageArgumentScrollViewScrollPage argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll by the layout height of that Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollEdgeProperty
 Use the MessageArgumentScrollViewScrollEdge argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll to either of the edges. More...
 
static PropertyType< float > MessageArgumentScrollViewZoomProperty
 Use the MessageArgumentScrollViewZoom argument to set the zoom level for a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewSnapPositionProperty
 Use the MessageArgumentScrollViewSnapPosition argument to set the target of a snap request. More...
 
static PropertyType< Vector2MessageArgumentScrollViewSnapDirectionProperty
 Use the MessageArgumentScrollViewSnapDirection argument to set the direction of a snap request. More...
 
static PropertyType< float > RecognitionThresholdProperty
 Use the Recognition Threshold property to set the amount a pointing device must move for the scrolling to start on a Scroll View node. More...
 
static PropertyType< int > MinimumNumberOfTouchesProperty
 Use the Minimum Number Of Touches property to set the required number of touch points pressed for a Scroll View node pan to start. More...
 
static PropertyType< int > MaximumNumberOfTouchesProperty
 Use the Maximum Number Of Touches property to set the maximum number of touch points allowed for a Scroll View to pan. More...
 
static PropertyType< float > SensitivityProperty
 Use the Sensitivity property to set the amount the position changes relative to the movement of the pointer that starts the swiping. More...
 
static PropertyType< float > SlidingAccelerationCoefficientProperty
 Use the Sliding Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
static PropertyType< float > SlidingDragCoefficientProperty
 Use the Sliding Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
static PropertyType< float > DraggingAccelerationCoefficientProperty
 Use the Dragging Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
static PropertyType< float > DraggingDragCoefficientProperty
 Use the Dragging Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
static PropertyType< float > DraggingImpulseFactorProperty
 Use the Dragging Impulse Factor property to set the amount of impulse generated from the pointing device movement when dragging a Scroll View node. More...
 
static PropertyType< float > SwipeDistanceProperty
 Use the Swipe Distance property to set the distance that a swipe sends the scroll value, relative to the pointing device speed. More...
 
static PropertyType< Vector2ScrollPositionProperty
 Reports the scroll position of the Scroll View node along the x and y axes as a relative position within the Scroll View area. More...
 
static PropertyType< Vector2ScrollTargetPositionProperty
 Use the Scroll Target Position property to set the value for the current scroll target. More...
 
static PropertyType< Vector2ScrollSpeedProperty
 Use the Scroll Speed property to set the current scroll speed. More...
 
static PropertyType< bool > ScrollingProperty
 Use the Scrolling property to find out whether a Scroll View node is currently scrolling. More...
 
static PropertyType< bool > ZoomAffectsScrollingProperty
 Use the Zoom Affects Scrolling property to set whether the scroll position is scaled according to the zoom level. More...
 
static PropertyType< Vector2ScrollBoundsMinimumProperty
 Use the Scroll Bounds Minimum property to set the coordinates of the top-left corner of the scroll bounds rectangle. More...
 
static PropertyType< Vector2ScrollBoundsMaximumProperty
 Use the Scroll Bounds Maximum property to set the coordinates of the bottom-right corner of the scroll bounds rectangle. More...
 
static PropertyType< bool > LoopingXEnabledProperty
 Use the Looping X Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis. More...
 
static PropertyType< bool > LoopingYEnabledProperty
 Use the Looping Y Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis. More...
 
static PropertyType< bool > ZoomEnabledProperty
 Use the Zoom Enabled property to set whether to install a pinch manipulator that generates zoom messages. More...
 
static PropertyType< float > ZoomProperty
 Use the Zoom property to set the current zoom level. More...
 
static PropertyType< float > ZoomMinimumProperty
 Use the Zoom Minimum property to set the minimum zoom level. More...
 
static PropertyType< float > ZoomMaximumProperty
 Use the Zoom Maximum property to set the maximum zoom level. More...
 
static PropertyType< float > StepMultiplierProperty
 Use the Step Multiplier property to set the smallest distance that a Scroll View scrolls. More...
 
static PropertyType< AllowedScrollAxisAllowedScrollAxisProperty
 Sets the axis on which you want to allow a Scroll View node to scroll. More...
 

Detailed Description

template<typename TBaseClass, class TDerivedClass>
class kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >

Implementation class for ScrollViewConcept.

Member Typedef Documentation

◆ TScrollView

template<typename TBaseClass, class TDerivedClass>
typedef ScrollViewConceptImpl<TBaseClass, TDerivedClass> kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::TScrollView

Constructor & Destructor Documentation

◆ ~ScrollViewConceptImpl()

template<typename TBaseClass , class TDerivedClass >
kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::~ScrollViewConceptImpl ( )
override

Destructor.

◆ ScrollViewConceptImpl()

template<typename TBaseClass , class TDerivedClass >
kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::ScrollViewConceptImpl ( Domain domain,
string_view  name 
)
explicitprotected

Member Function Documentation

◆ makeEditorInfo()

template<typename TBaseClass , class TDerivedClass >
PropertyTypeEditorInfoSharedPtr kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )
static

◆ getPanManipulator()

template<typename TBaseClass , class TDerivedClass >
PanManipulatorSharedPtr kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getPanManipulator ( ) const

Returns the pan manipulator.

◆ getRecognitionThreshold()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getRecognitionThreshold ( ) const
inline

◆ setRecognitionThreshold()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setRecognitionThreshold ( float  value)
inline

◆ getMinimumNumberOfTouches()

template<typename TBaseClass, class TDerivedClass>
int kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getMinimumNumberOfTouches ( ) const
inline

◆ setMinimumNumberOfTouches()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setMinimumNumberOfTouches ( int  value)
inline

Sets the value of the MinimumNumberOfTouchesProperty.

Scroll views with minimum number of touches greater than one will precede the descendants in touch event processing.

See also
getMinimumNumberOfTouches()

◆ getMaximumNumberOfTouches()

template<typename TBaseClass, class TDerivedClass>
int kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getMaximumNumberOfTouches ( ) const
inline

◆ setMaximumNumberOfTouches()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setMaximumNumberOfTouches ( int  value)
inline

◆ getSensitivity()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getSensitivity ( ) const
inline

Gets the value of the SensitivityProperty.

See also
setSensitivity()

◆ setSensitivity()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setSensitivity ( float  value)
inline

Sets the value of the SensitivityProperty.

See also
getSensitivity()

◆ getSlidingAccelerationCoefficient()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getSlidingAccelerationCoefficient ( ) const
inline

◆ setSlidingAccelerationCoefficient()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setSlidingAccelerationCoefficient ( float  value)
inline

◆ getSlidingDragCoefficient()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getSlidingDragCoefficient ( ) const
inline

◆ setSlidingDragCoefficient()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setSlidingDragCoefficient ( float  value)
inline

◆ getDraggingAccelerationCoefficient()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getDraggingAccelerationCoefficient ( ) const
inline

◆ setDraggingAccelerationCoefficient()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setDraggingAccelerationCoefficient ( float  value)
inline

◆ getDraggingDragCoefficient()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getDraggingDragCoefficient ( ) const
inline

◆ setDraggingDragCoefficient()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setDraggingDragCoefficient ( float  value)
inline

◆ getDraggingImpulseFactor()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getDraggingImpulseFactor ( ) const
inline

◆ setDraggingImpulseFactor()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setDraggingImpulseFactor ( float  value)
inline

◆ getSwipeDistance()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getSwipeDistance ( ) const
inline

Gets the value of the SwipeDistanceProperty.

See also
setSwipeDistance()

◆ setSwipeDistance()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setSwipeDistance ( float  value)
inline

Sets the value of the SwipeDistanceProperty.

See also
getSwipeDistance()

◆ getScrollPosition()

template<typename TBaseClass, class TDerivedClass>
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollPosition ( ) const
inline

Gets the value of the ScrollPositionProperty.

See also
setScrollPosition()

◆ setScrollPosition()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollPosition ( Vector2  value)
inline

Sets the value of the ScrollPositionProperty.

See also
getScrollPosition()

◆ getScrollTargetPosition()

template<typename TBaseClass, class TDerivedClass>
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollTargetPosition ( ) const
inline

◆ setScrollTargetPosition()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollTargetPosition ( Vector2  value)
inline

◆ getScrollSpeed()

template<typename TBaseClass, class TDerivedClass>
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollSpeed ( ) const
inline

Gets the value of the ScrollSpeedProperty.

See also
setScrollSpeed()

◆ setScrollSpeed()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollSpeed ( Vector2  value)
inline

Sets the value of the ScrollSpeedProperty.

See also
getScrollSpeed()

◆ isScrolling()

template<typename TBaseClass, class TDerivedClass>
bool kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::isScrolling ( ) const
inline

Gets the value of the ScrollingProperty.

See also
setScrolling()

◆ setScrolling()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrolling ( bool  value)
inline

Sets the value of the ScrollingProperty.

See also
isScrolling()

◆ isDragging()

template<typename TBaseClass , class TDerivedClass >
bool kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::isDragging ( ) const

Checks whether a finger is on the surface.

◆ isZoomAffectsScrolling()

template<typename TBaseClass, class TDerivedClass>
bool kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::isZoomAffectsScrolling ( ) const
inline

◆ setZoomAffectsScrolling()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setZoomAffectsScrolling ( bool  value)
inline

◆ getScrollBoundsMinimum()

template<typename TBaseClass, class TDerivedClass>
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollBoundsMinimum ( ) const
inline

Gets the value of the ScrollBoundsMinimumProperty.

See also
setScrollBoundsMinimum()

◆ setScrollBoundsMinimum()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollBoundsMinimum ( Vector2  value)
inline

Sets the value of the ScrollBoundsMinimumProperty.

See also
getScrollBoundsMinimum()

◆ getScrollBoundsMaximum()

template<typename TBaseClass, class TDerivedClass>
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollBoundsMaximum ( ) const
inline

Gets the value of the ScrollBoundsMaximumProperty.

See also
setScrollBoundsMaximum()

◆ setScrollBoundsMaximum()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollBoundsMaximum ( Vector2  value)
inline

Sets the value of the ScrollBoundsMaximumProperty.

See also
getScrollBoundsMaximum()

◆ setLoopingXEnabled()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setLoopingXEnabled ( bool  value)
inline

Sets the value of the LoopingXEnabledProperty.

See also
isLoopingXEnabled()

◆ setLoopingYEnabled()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setLoopingYEnabled ( bool  value)
inline

Sets the value of the LoopingYEnabledProperty.

See also
isLoopingYEnabled()

◆ isLoopingXEnabled()

template<typename TBaseClass, class TDerivedClass>
bool kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::isLoopingXEnabled ( ) const
inline

Gets the value of the LoopingXEnabledProperty.

See also
setLoopingXEnabled()

◆ isLoopingYEnabled()

template<typename TBaseClass, class TDerivedClass>
bool kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::isLoopingYEnabled ( ) const
inline

Gets the value of the LoopingYEnabledProperty.

See also
setLoopingYEnabled()

◆ setScrollBoundsX()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollBoundsX ( float  minimum,
float  maximum 
)

Sets the bounds on the x axis.

When scrolling outside of the bounds, after the scrolling ends, the scroll position converges to the nearest bound value.

Parameters
minimumRepresents the right edge of a Scroll View.
maximumRepresents the left edge of a Scroll View.
See also
setLoopingXEnabled(), isLoopingXEnabled()

◆ setScrollBoundsY()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setScrollBoundsY ( float  minimum,
float  maximum 
)

Sets the bounds on the y axis.

When scrolling outside of the bounds, after the scrolling ends, the scroll position converges to the nearest bound value.

Parameters
minimumRepresents the bottom edge of a Scroll View.
maximumRepresents the top edge of a Scroll View.
See also
setLoopingYEnabled(), isLoopingYEnabled()

◆ scrollToPosition()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::scrollToPosition ( Vector2  scrollPosition)

Sets the value for the scroll position within a Scroll View and starts scrolling to that value.

Use this function when you have the exact scroll position in a Scroll View and want to scroll to that position. If you enabled the looping for the scroll view, the target value can be out of bounds to indicate direction and repetition.

Parameters
scrollPositionThe position of the scroll view to which you want to set the scroll view to start scrolling.
See also
scrollToPositionLooping(), jumpToPosition(), setLoopingXEnabled(), setLoopingYEnabled()

◆ scrollToPositionLooping()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::scrollToPositionLooping ( Vector2  scrollPosition)

If you enabled the axis looping for a Scroll View, Kanzi uses the shortest path to the target value.

Parameters
scrollPositionThe position of a Scroll View to which you want to set the Scroll View to start scrolling.
See also
jumpToPosition(), scrollToPositionLooping(), setLoopingXEnabled(), setLoopingYEnabled(), isLoopingXEnabled(), isLoopingYEnabled()

◆ jumpToPosition()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::jumpToPosition ( Vector2  scrollPosition)

Sets the value for a scroll position within a Scroll View and goes to that position immediatelly without scrolling.

Parameters
scrollPositionThe scroll position to which you want the Scroll View to go without scrolling.
See also
scrollToPositionLooping(), scrollToPosition()

◆ getScroll()

template<typename TBaseClass , class TDerivedClass >
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScroll ( ) const

Gets the values of the current scroll position of a Scroll View.

If you enable looping for that Scroll View, the value of the position this function returns is normalized so that it is within the bound interval.

Returns
Returns the current scroll position of the Scroll View.

◆ getScrollTarget()

template<typename TBaseClass , class TDerivedClass >
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollTarget ( ) const

Gets the values of the scroll position of a Scroll View to which the Scroll View is scrolling.

Use this function when you want to find out the scrolling position towards which the Scroll View is scrolling. If you enable looping for a Scroll View, the value of the position this function returns can be out of bounds of the Scroll View.

Returns
Returns the scroll position to which the Scroll View is scrolling.

◆ getScrollTargetLooping()

template<typename TBaseClass , class TDerivedClass >
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getScrollTargetLooping ( ) const

When you enable looping, returns the scroll position value normalized to the allowed range of a Scroll View.

Kanzi uses the returned value to set the value of the ScrollTargetPositionProperty.

Returns
Returns the normalized value of the scroll position to which the Scroll View is scrolling.

◆ getSpeed()

template<typename TBaseClass , class TDerivedClass >
Vector2 kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getSpeed ( ) const

Queries the interpolator for the current speed.

Kanzi internally uses the returned value to calculate the target scroll position.

See also
getScrollTarget()

◆ scroll() [1/3]

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::scroll ( ScrollDirection  direction)

Sets the scroll delta to one step and starts scrolling in that direction.

Parameters
directionScroll direction.
See also
StepMultiplierProperty

◆ scroll() [2/3]

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::scroll ( ScrollPage  direction)

Sets the scroll delta to one distance of the layout height of a Scroll View and starts scrolling in that direction.

Parameters
directionScroll direction.

◆ scroll() [3/3]

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::scroll ( ScrollEdge  direction)

Sets the scroll target to the edge defined by the scroll bounds and starts scrolling in that direction.

Parameters
directionScroll direction.
See also
ScrollBoundsMinimumProperty, ScrollBoundsMaximumProperty

◆ isZoomEnabled()

template<typename TBaseClass, class TDerivedClass>
bool kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::isZoomEnabled ( ) const
inline

Gets the value of the ZoomEnabledProperty.

◆ setZoomEnabled()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setZoomEnabled ( bool  value)
inline

Sets the value of the ZoomEnabledProperty.

◆ getZoom()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getZoom ( ) const
inline

Gets the value of the ZoomProperty.

Returns
The value of the zoom property.
See also
setZoom()

◆ setZoom()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setZoom ( float  value)
inline

Sets the value of the ZoomProperty.

Parameters
valueThe new value of the zoom property.
See also
getZoom()

◆ getZoomMinimum()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getZoomMinimum ( ) const
inline

Gets the value of the ZoomMinimumProperty.

See also
setZoomMinimum()

◆ setZoomMinimum()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setZoomMinimum ( float  value)
inline

Sets the value of the ZoomMinimumProperty.

See also
getZoomMinimum()

◆ getZoomMaximum()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getZoomMaximum ( ) const
inline

Gets the value of the ZoomMaximumProperty.

See also
setZoomMaximum()

◆ setZoomMaximum()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setZoomMaximum ( float  value)
inline

Sets the value of the ZoomMaximumProperty.

See also
getZoomMaximum()

◆ getStepMultiplier()

template<typename TBaseClass, class TDerivedClass>
float kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getStepMultiplier ( ) const
inline

Gets the value of the StepMultiplierProperty.

See also
setStepMultiplier(), scroll()

◆ setStepMultiplier()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setStepMultiplier ( float  value)
inline

Sets the value of the StepMultiplierProperty.

See also
getStepMultiplier(), scroll()

◆ getAllowedScrollAxis()

template<typename TBaseClass, class TDerivedClass>
AllowedScrollAxis kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getAllowedScrollAxis ( ) const
inline

Returns the value of the AllowedScrollAxisProperty.

See also
setAllowedScrollAxis()

◆ setAllowedScrollAxis()

template<typename TBaseClass, class TDerivedClass>
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::setAllowedScrollAxis ( AllowedScrollAxis  axis)
inline

Sets the value of the AllowedScrollAxisProperty.

Parameters
axisThe axis on which you want to allow scrolling.
See also
getAllowedScrollAxis.

◆ refreshThreshold()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::refreshThreshold ( )

Updates the recognition threshold of the pan manipulator to the value of the RecognitionThresholdProperty value.

See also
PanManipulator::setRecognitionThreshold

◆ enableKeyNavigation()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::enableKeyNavigation ( bool  enabled)

Enables directional keyboard navigation on the Scroll View.

Parameters
enabledTo enable keyboard navigation, pass true. To disable keyboard navigation, pass false.
Since
Kanzi 3.9.1

◆ getThisObject() [1/2]

template<typename TBaseClass, class TDerivedClass>
TDerivedClass* kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getThisObject ( )
inlineprotected

Internal accessor for the Curiously Recurring Template Pattern.

◆ getThisObject() [2/2]

template<typename TBaseClass, class TDerivedClass>
const TDerivedClass* kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::getThisObject ( ) const
inlineprotected

Internal accessor for the Curiously Recurring Template Pattern.

◆ initialize()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::initialize ( )
protected

Assigns the message handlers for the pan manipulator and scroll messages.

◆ onNodePropertyChanged()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotected

◆ refreshScrollConfiguration()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::refreshScrollConfiguration ( )
protected

Kanzi internally uses this helper function to update smooth interpolation coefficients between starting and stopping the interpolator timer, depending on whether a finger is still on a Scroll View node.

◆ refreshMinimumNumberOfTouches()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::refreshMinimumNumberOfTouches ( )
protected

Kanzi internally uses this helper function to update the minimum number of touch points of the pan manipulator to the value of the MinimumNumberOfTouchesProperty value.

See also
PanManipulator::setMinimumNumberOfTouches

◆ refreshMaximumNumberOfTouches()

template<typename TBaseClass , class TDerivedClass >
void kanzi::ScrollViewConceptImpl< TBaseClass, TDerivedClass >::refreshMaximumNumberOfTouches ( )
protected

Kanzi internally updates the maximum number of touch points of the pan manipulator to the value of the MaximumNumberOfTouchesProperty value.

See also
PanManipulator::setMaximumNumberOfTouches

The documentation for this class was generated from the following files: