PullToRefreshRotateGizmo Class

Implementation of PullToRefreshGizmo that uses a rotating image to show the pull progress.

The image is rotated by the amount of distance traveled by the click/finger.

When enough pulling distance is covered the gizmo enters the "ready to refresh" state,

the rotation amount applied is damped by _ExcessPullRotationDamping (i.e. a value of 1f won't apply any furter rotation,

while a value of 0f will apply the same amount of rotation per distance traveled by the click/finger as before the "ready to refresh" state).

When OnRefreshed(Boolean) is called with true, the gizmo will disappear; if it'll be called with false,

it'll start auto-rotating with a speed of _AutoRotationDegreesPerSec degrees per second, until IsShown is set to false.

This last use-case is very common for when the refresh event actually takes time (i.e. retrieving items from a server).

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Com.ForbiddenByte.OSA.Util.PullToRefreshPullToRefreshGizmo
            Com.ForbiddenByte.OSA.Util.PullToRefreshPullToRefreshRotateGizmo

Namespace: Com.ForbiddenByte.OSA.Util.PullToRefresh
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0

Syntax

public class PullToRefreshRotateGizmo : PullToRefreshGizmo

The PullToRefreshRotateGizmo type exposes the following members.

Constructors

	Name	Description
	PullToRefreshRotateGizmo

Properties

	Name	Description
	IsShown	Calls base implementation + resets the rotation to default each time is assigned, regardless if true or false (Overrides PullToRefreshGizmoIsShown.)

Methods

	Name	Description
	Awake	(Overrides PullToRefreshGizmoAwake.)
	OnPull	(Overrides PullToRefreshGizmoOnPull(Double).)
	OnRefreshCancelled	(Overrides PullToRefreshGizmoOnRefreshCancelled.)
	OnRefreshed	(Overrides PullToRefreshGizmoOnRefreshed(Boolean).)

Version Information

Supported in: 4.1