Shows visual debugging elements for scroll area bounds and content.
Enables physics-based scrolling where content continues moving after release with gradual deceleration and elastic bounce-back at boundaries."
Controls how much content must remain visible. 0: Content can scroll completely out of view. 0.5: At least 50% of the content will remain in the visible area. 1: Content can't scroll out of view at all.
ReadonlyapiGeneric object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.
If disabled, the Component will stop enacting its behavior.
Allows content to be scrolled horizontally.
When enabled, prevents content from scrolling beyond designated boundaries defined by the Scroll Limit.
Allows content to be scrolled vertically.
ReadonlyisReturns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
Relevant only to lenses that use SpectaclesSyncKit when it has SyncInteractionManager in its prefab. If set to true before runtime, the ScrollView's position will be synced whenever a new user joins the same Connected Lenses session.
ReadonlysceneThe SceneObject this component is on.
Defines the size of the interactive area in normalized local coordinates, where (1,1) uses the full component size.
Readonlyuniquethe length of the content along the y-axis in local units relative to the ScrollView canvas.
the length of the content along the y-axis in local units relative to the ScrollView canvas.
the offset to each content edge and the ScrollArea in world units relative to the canvas' rotation.
if the ScrollView is being manually controlled by some component beyond ScrollView (e.g. ScrollBar)
Sets if the ScrollView is being manually controlled by some component beyond ScrollView (e.g. ScrollBar)
if this class is ready to be used.
the amount of content overflow along the y-axis in local units relative to the ScrollView's canvas.
the ScrollArea's size in local units relative to the ScrollView canvas.
the scroll percentage of the ScrollView (0=top of ScrollView, 1= bottom).
Checks if both inputted content edges are fully visible in the ScrollArea.
0 if not checking any x-axis edge, 1 for right edge, -1 for left edge.
0 if not checking any y-axis edge, 1 for top edge, -1 for bottom edge.
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
Destroys the component.
Returns the SceneObject the component is attached to.
Returns the Transform this component is attached to.
StaticgetReturns the name of this object's type.
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Removes a previously added SceneEvent from the ScriptComponent.
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.
Resets the inertia velocity in the case that the developer wants to stop physics upon certain events.
This class is responsible for creating and positioning grid content items based on a specified prefab and item count. It instantiates the items and arranges them vertically with a specified offset.
Deprecated
in favor of using SpectaclesUIKit's ScrollView component. See https://developers.snap.com/spectacles/spectacles-frameworks/spectacles-ui-kit/get-started for more details.