Class ScrollProvider

constructor

• new ScrollProvider(config: ScrollProviderConfig): ScrollProvider

  Parameters

  • config: ScrollProviderConfig

  Returns ScrollProvider

ReadonlyonReady

ReadonlyonScrollUpdate

ReadonlyonSnapUpdate

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

• get contentOffset(): Rect

  Returns Rect

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

  • position: vec3

  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

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

  • offset: Rect

  Returns Rect

convertLocalUnitsToParentUnits

• convertLocalUnitsToParentUnits(localUnits: vec2): vec2

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

  Parameters

  • localUnits: vec2

  Returns vec2

onGrabEnd

• onGrabEnd(event: InteractorEvent): void

  Parameters

  • event: InteractorEvent

  Returns void

onGrabStart

• onGrabStart(event: InteractorEvent): void

  Parameters

  • event: InteractorEvent

  Returns void

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

setContent

• setContent(content: SceneObjectBoundariesProvider): void

  Sets scroll content. Should be called only one time to initialize the content and binds to onStartEvent.

  Parameters

  • content: SceneObjectBoundariesProvider

    defines content boundaries

  Returns void

snapToEdges

• snapToEdges(selectedEdges: EdgeSelector): void

  Snaps content to the selected edges

  Parameters

  • selectedEdges: EdgeSelector

    Struct that describes the selected edge as an EdgeSelector

  Returns void