Class ScrollProvider

Describes the scrolling logic between the content and the container

Constructors

constructor

Properties

_contentLength _enableScrollInertia _scrollLimit cancelSet config content contentOrigin contentScrollLimit decelerateMinSpeed decelerateTime dragVelocity dragVelocityFilter elasticMinDistance elasticTime enableScrollLimit inertiaVelocity isGrabbed isXOverflow isYOverflow onReady onReadyEvent onScrollUpdate onScrollUpdateEvent onSnapUpdate onSnapUpdateEvent scrollArea scrollView

Accessors

contentLength contentOffset contentPosition enableScrollInertia isReady overflow scrollLimit scrollLimitOffset scrollPercentage

Methods

applyElasticity applyFriction checkContentEdgeFullyVisible convertLocalOffsetToParentOffset convertLocalUnitsToParentUnits convertLocalUnitsToWorldUnits getOffsetToEdge isEdgeInsideScrollArea limitToEdgeInstantly offsetBetween onGrabEnd onGrabStart recomputeBoundaries resetContentOrigin resetInertiaVelocity scrollBy selectEdgesInsideScrollArea setContent snapToEdges update updateInertiaVelocity

Constructors

constructor

Properties

Private_contentLength

_contentLength: number = 0

Private_enableScrollInertia

_enableScrollInertia: boolean

Private_scrollLimit

_scrollLimit: number

PrivatecancelSet

cancelSet: CancelSet = ...

Privateconfig

config: ScrollProviderConfig

Privatecontent

content: SceneObjectBoundariesProvider

PrivatecontentOrigin

contentOrigin: vec2 = ...

PrivatecontentScrollLimit

contentScrollLimit: BufferedBoundariesProvider

PrivatedecelerateMinSpeed

decelerateMinSpeed: number = DECELERATE_MIN_SPEED

PrivatedecelerateTime

decelerateTime: number = DECELERATE_TIME

PrivatedragVelocity

dragVelocity: vec2 = ...

PrivatedragVelocityFilter

dragVelocityFilter: MovingAverageFilter<vec2> = ...

PrivateelasticMinDistance

elasticMinDistance: number = ELASTIC_MIN_DISTANCE

PrivateelasticTime

elasticTime: number = ELASTIC_TIME

PrivateenableScrollLimit

enableScrollLimit: boolean

PrivateinertiaVelocity

inertiaVelocity: vec2 = ...

PrivateisGrabbed

isGrabbed: boolean = false

PrivateisXOverflow

isXOverflow: boolean = false

PrivateisYOverflow

isYOverflow: boolean = false

ReadonlyonReady

onReady: PublicApi<void> = ...

PrivateonReadyEvent

onReadyEvent: default<void> = ...

ReadonlyonScrollUpdate

onScrollUpdate: PublicApi<ScrollViewEventArgs> = ...

PrivateonScrollUpdateEvent

onScrollUpdateEvent: default<ScrollViewEventArgs> = ...

ReadonlyonSnapUpdate

onSnapUpdate: PublicApi<ScrollViewEventArgs> = ...

PrivateonSnapUpdateEvent

onSnapUpdateEvent: default<ScrollViewEventArgs> = ...

PrivatescrollArea

scrollArea: SceneObjectBoundariesProvider = ...

PrivatescrollView

scrollView: ScrollView = ...

Accessors

contentLength

  • get contentLength(): number

    Returns number

    the content length along the Y-axis

  • set contentLength(length: number): void

    Sets the true length of the content in the case of pooling / other non-default use cases

    Parameters

    • length: number

    Returns void

contentOffset

contentPosition

  • get contentPosition(): vec3

    Returns vec3

    the content position in local space

  • set contentPosition(position: vec3): void

    Sets the position of the content in local space

    Parameters

    Returns void

enableScrollInertia

  • get enableScrollInertia(): boolean

    Returns boolean

    if the ScrollView will continue scrolling on release

  • set enableScrollInertia(enableScrollInertia: boolean): void

    Toggles if the ScrollView should continue scrolling on release

    Parameters

    • enableScrollInertia: boolean

    Returns void

isReady

  • get isReady(): boolean

    Returns boolean

    if this class is ready to be used, which means that content is set

overflow

  • get overflow(): number

    Returns number

scrollLimit

  • get scrollLimit(): number

    Returns number

    what amount of the scroll area should always be occupied

  • set scrollLimit(limit: number): void

    Sets the amount of the scroll area should always be occupied

    Parameters

    • limit: number

    Returns void

scrollLimitOffset

  • get scrollLimitOffset(): Rect

    Returns Rect

scrollPercentage

  • get scrollPercentage(): number

    Returns number

Methods

PrivateapplyElasticity

  • applyElasticity(
        position: vec3,
        velocity: vec2,
        elasticTime: number,
        deltaTime: number,
    ): [vec3, vec2]

    Parameters

    • position: vec3
    • velocity: vec2
    • elasticTime: number
    • deltaTime: number

    Returns [vec3, vec2]

PrivateapplyFriction

  • applyFriction(
        position: vec3,
        velocity: vec2,
        decelerateTime: number,
        deltaTime: number,
    ): [vec3, vec2]

    Parameters

    • position: vec3
    • velocity: vec2
    • decelerateTime: number
    • deltaTime: number

    Returns [vec3, vec2]

checkContentEdgeFullyVisible

  • checkContentEdgeFullyVisible(xEdge: -1 | 0 | 1, yEdge: -1 | 0 | 1): boolean

    Checks if both inputted content edges are fully visible in the ScrollArea.

    Parameters

    • xEdge: -1 | 0 | 1

      0 if not checking any x-axis edge, 1 for right edge, -1 for left edge.

    • yEdge: -1 | 0 | 1

      0 if not checking any y-axis edge, 1 for top edge, -1 for bottom edge.

    Returns boolean

convertLocalOffsetToParentOffset

  • convertLocalOffsetToParentOffset(offset: Rect): Rect

    Converts the offset (normalized -1 to 1) to local units relative to the ScrollView canvas.

    Parameters

    Returns Rect

convertLocalUnitsToParentUnits

  • convertLocalUnitsToParentUnits(localUnits: vec2): vec2

    Converts local units (-1 to 1) to parent units relative to the ScrollView canvas.

    Parameters

    Returns vec2

PrivateconvertLocalUnitsToWorldUnits

  • convertLocalUnitsToWorldUnits(localUnits: vec2): vec2

    Converts local units (normalized -1 to 1) to world units relative to the ScrollView canvas.

    Parameters

    Returns vec2

PrivategetOffsetToEdge

PrivateisEdgeInsideScrollArea

  • isEdgeInsideScrollArea(edgeType: "Content" | "ScrollLimit"): boolean

    Returns true if any edge of the given type is inside the scroll region, as long as the content is large enough in that dimension to be scrollable.

    Parameters

    • edgeType: "Content" | "ScrollLimit"

      the type of edge to check for

    Returns boolean

PrivatelimitToEdgeInstantly

  • limitToEdgeInstantly(edgeType: "Content" | "ScrollLimit"): void

    If there is a edge of the given type inside the scroll area, instantly snap to the edge.

    Parameters

    • edgeType: "Content" | "ScrollLimit"

      The type of edge to snap to.

    Returns void

PrivateoffsetBetween

onGrabEnd

onGrabStart

recomputeBoundaries

  • recomputeBoundaries(): void

    Recomputes content and scroll area boundaries

    Returns void

resetContentOrigin

  • resetContentOrigin(): void

    Resets the content origin for the purpose of calculating scrollPercentage. Assumes that the ScrollView is currently at the top of content in the pooling use case.

    Returns void

resetInertiaVelocity

  • resetInertiaVelocity(): void

    Resets the inertia velocity in the case that the developer wants to stop physics upon certain events.

    Returns void

scrollBy

  • scrollBy(dragVector: vec2): void

    Scrolls content according to a drag vector, along the enabled axis

    Parameters

    • dragVector: vec2

      2D vector to move the content

    Returns void

PrivateselectEdgesInsideScrollArea

  • selectEdgesInsideScrollArea(edgeType: "Content" | "ScrollLimit"): EdgeSelector

    Parameters

    • edgeType: "Content" | "ScrollLimit"

    Returns EdgeSelector

setContent

snapToEdges

  • snapToEdges(selectedEdges: EdgeSelector): void

    Snaps content to the selected edges

    Parameters

    Returns void

Privateupdate

  • update(): void

    Returns void

PrivateupdateInertiaVelocity

  • updateInertiaVelocity(): void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR