FloUI.Scrollable.Drag (FloUI v0.1.0-alpha.6) View Source

Module for handling the drag controllability for Scenic.Scrollable components.

Link to this section Summary

Types

Atom representing what state the drag functionality is currently in. The drag state can be 'idle' or 'dragging'.

Atom representing a mouse button.

Data structure with settings that dictate the behaviour of the drag controllability. It consists of a list with t:Scenic.Scrollable.Drag.mouse_button/0s which specify the buttons with which the user can drag the Scenic.Scrollable component. By default, drag functionality is disabled.

t()

The state containing the necessary information to enable the drag functionality.

v2()

Shorthand for Scenic.Math.vector_2/0. Consists of a tuple containing the x and y numeric values.

Functions

amplify_speed(_, speed)

Increases the current scroll speed, intended to be called when the user stops dragging. The increase in speed is intended to make the drag experience more smooth.

dragging?(map)

Find out if the user is currently dragging the Scenic.Scrollable component.

handle_mouse_click(state, button, point, content_position)

Update the t:Scenic.Scrollable.Drag.t/0 based on the pressed mouse button, mouse position, and the position of the scrollable content.

handle_mouse_move(state, point)

Update the t:Scenic.Scrollable.Drag.t/0 based on the new cursor position the user has moved to.

handle_mouse_release(state, button, point)

Update the t:Scenic.Scrollable.Drag.t/0 based on the released mouse button and mouse position.

init(settings)

Initialize the t:Scenic.Scrollable.Drag.t/0 state by passing in the t:Scenic.Scrollable.Drag.settings/0 settings object. When nil is passed, the default settings will be used.

last_position(map)

Get the position of the users cursor during the previous update. Returns an the coordinate.

new_position(map)

Calculate the new scroll position based on the current drag state. The result will be wrapped in an.

Link to this section Types

drag_state()

Specs

drag_state() :: :idle | :dragging

Atom representing what state the drag functionality is currently in. The drag state can be 'idle' or 'dragging'.

mouse_button()

Specs

mouse_button() :: 0 | 1 | 2

Atom representing a mouse button.

settings()

Specs

settings() :: %{mouse_buttons: [mouse_button()]}

t()

Specs

t() :: %FloUI.Scrollable.Drag{
  current: v2(),
  drag_start: v2(),
  drag_start_content_position: v2(),
  drag_state: drag_state(),
  enabled_buttons: [mouse_button()]
}

The state containing the necessary information to enable the drag functionality.

v2()

Specs

v2() :: Scenic.Math.vector_2()

Shorthand for Scenic.Math.vector_2/0. Consists of a tuple containing the x and y numeric values.

Link to this section Functions

amplify_speed(_, speed)

Specs

amplify_speed(t(), v2()) :: v2()

Increases the current scroll speed, intended to be called when the user stops dragging. The increase in speed is intended to make the drag experience more smooth.

dragging?(map)

Specs

dragging?(t()) :: boolean()

Find out if the user is currently dragging the Scenic.Scrollable component.

handle_mouse_click(state, button, point, content_position)

Specs

handle_mouse_click(t(), mouse_button(), v2(), v2()) :: t()

Update the t:Scenic.Scrollable.Drag.t/0 based on the pressed mouse button, mouse position, and the position of the scrollable content.

handle_mouse_move(state, point)

Specs

handle_mouse_move(t(), v2()) :: t()

Update the t:Scenic.Scrollable.Drag.t/0 based on the new cursor position the user has moved to.

handle_mouse_release(state, button, point)

Specs

handle_mouse_release(t(), mouse_button(), v2()) :: t()

Update the t:Scenic.Scrollable.Drag.t/0 based on the released mouse button and mouse position.

init(settings)

Specs

init(nil | settings()) :: t()

Initialize the t:Scenic.Scrollable.Drag.t/0 state by passing in the t:Scenic.Scrollable.Drag.settings/0 settings object. When nil is passed, the default settings will be used.

last_position(map)

Specs

last_position(t()) :: v2()

Get the position of the users cursor during the previous update. Returns an the coordinate.

new_position(map)

Specs

new_position(t()) :: v2()

Calculate the new scroll position based on the current drag state. The result will be wrapped in an.