.. index:: pair: class; EE::UI::UIScrollController
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller:

class EE::UI::UIScrollController
================================

.. toctree::
	:hidden:

	struct_EE_UI_UIScrollController_SmoothTween.rst

Overview
~~~~~~~~

Allocation-free, frame-rate-independent scroll motion state. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_scroll_controller>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <uiscrollcontroller.hpp>
	
	class UIScrollController {
	public:
		// structs
	
		struct :ref:`SmoothTween<doxid-struct_e_e_1_1_u_i_1_1_u_i_scroll_controller_1_1_smooth_tween>`;

		// methods
	
		void :ref:`setPosition<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1aef1fc0ac8d738495c84d95f458f78381>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition);
		bool :ref:`scrollBy<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a45263d534623251b68de9023794bcf21>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& delta, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& currentPosition, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition, bool smooth, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` durationScale = 1.f);
		void :ref:`beginDrag<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a328c4e21e5239396714eadc04289abb2>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition);
		bool :ref:`dragBy<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a6ce77ba97add40289fe8a32dc3fde031>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& delta, const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& elapsed, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition);
		void :ref:`endDrag<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a3409c9e309e056d62c057e3db31c2857>`();
		bool :ref:`update<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a06dc17927f629f3a05769ead696df4cf>`(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& elapsed, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition);
		void :ref:`stop<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a0428041eadbe1817a790908e5a674acb>`();
		bool :target:`isActive<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1aacb6d23fbe639ddac309619115c3fd27>`() const;
		bool :target:`isDragging<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a47c499b6146a6d462fb4a8b61625a389>`() const;
		const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& :target:`getPosition<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a994867ebb83569630b6bb3b2a159c078>`() const;
		const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& :target:`getTarget<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a68e386b1430de23f6aaf7f7a1c8a56cb>`() const;
		const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& :target:`getVelocity<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1ab79866d7f44895fb2260409951182806>`() const;
		:ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` :target:`getWheelScrollDuration<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1aaef6c0360b609dcade4374fcec5079ba>`() const;
		void :ref:`setWheelScrollDuration<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1af66c683da3cbb2301bfb6188c4710579>`(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& duration);
		:ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>` :target:`getDragDeceleration<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1ad6bfe70a803be767e4434e0284abd403>`() const;
		void :target:`setDragDeceleration<doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a33c59954d137a577002fa267cbd0a84b>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& deceleration);
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_scroll_controller:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Allocation-free, frame-rate-independent scroll motion state.

The controller operates in pixel coordinates but deliberately does not own a widget. This lets virtualized views, translated child views, and text editors share the same motion without forcing them into a common rendering hierarchy.

Methods
-------

.. index:: pair: function; setPosition
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1aef1fc0ac8d738495c84d95f458f78381:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setPosition(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition)

Synchronizes the controller with an externally changed scroll position and stops motion.

.. index:: pair: function; scrollBy
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a45263d534623251b68de9023794bcf21:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool scrollBy(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& delta, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& currentPosition, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition, bool smooth, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` durationScale = 1.f)

Adds a wheel displacement. Returns false when the target cannot move in either axis.

.. index:: pair: function; beginDrag
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a328c4e21e5239396714eadc04289abb2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void beginDrag(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition)

Starts direct manipulation at the current scroll position.

.. index:: pair: function; dragBy
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a6ce77ba97add40289fe8a32dc3fde031:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool dragBy(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& delta, const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& elapsed, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition)

Applies a drag displacement and records a filtered release velocity.

.. index:: pair: function; endDrag
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a3409c9e309e056d62c057e3db31c2857:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void endDrag()

Transitions a direct manipulation into inertial motion.

.. index:: pair: function; update
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a06dc17927f629f3a05769ead696df4cf:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool update(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& elapsed, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& maxPosition)

Advances smooth or inertial motion. Returns true when the position changed.

.. index:: pair: function; stop
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1a0428041eadbe1817a790908e5a674acb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void stop()

Stops all pending motion at the current controller position.

.. index:: pair: function; setWheelScrollDuration
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_scroll_controller_1af66c683da3cbb2301bfb6188c4710579:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setWheelScrollDuration(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& duration)

Sets the duration used to visually interpolate one wheel displacement.