Inheritance
SpatialScrollModule.SpatialScrollData
public class SpatialScrollData : INodeToRay
Constructors
Declaration
public SpatialScrollData(IControlSpatialScrolling caller, Node node, Vector3 startingPosition, Vector3 currentPosition, float repeatingScrollLengthRange, int scrollableItemCount, int maxItemCount = -1, bool centerVisuals = true)
Parameters
Properties
The object/caller initiating this particular spatial scroll action
Declaration
public IControlSpatialScrolling caller { get; set; }
Property Value
If true, expand scroll visuals out from the center of the trigger/origin/start position
Declaration
public bool centerVisuals { get; set; }
Property Value
The current scroll position
Declaration
public Vector3 currentPosition { get; set; }
Property Value
Value representing how much of the pre-scroll drag amount has occurred
Declaration
public float dragDistance { get; set; }
Property Value
Maximum number of items (to be scrolled through) that will be allowed
Declaration
public int maxItemCount { get; set; }
Property Value
The node on which this spatial scroll is being processed
Declaration
public Node node { get; set; }
Property Value
0-1 offset/magnitude of current scroll position, relative to the trigger/origin/start point, and the repeatingScrollLengthRange
Declaration
public float normalizedLoopingPosition { get; set; }
Property Value
Bool denoting that the scroll trigger magnitude has been exceeded
Declaration
public bool passedMinDragActivationThreshold { get; }
Property Value
The ray origin on which this spatial scroll is being processed
Declaration
public Transform rayOrigin { get; set; }
Property Value
| Type |
Description |
| Transform |
|
The magnitude at which a scroll will repeat/reset to its original scroll starting value
Declaration
public float repeatingScrollLengthRange { get; set; }
Property Value
Number of items being scrolled through
Declaration
public int scrollableItemCount { get; set; }
Property Value
The vector defining the spatial scroll direction
Declaration
public Vector3? spatialDirection { get; set; }
Property Value
The origin/starting position of the scroll
Declaration
public Vector3 startingPosition { get; set; }
Property Value
Methods
Declaration
public void UpdateExistingScrollData(Vector3 newPosition)
Parameters
| Type |
Name |
Description |
| Vector3 |
newPosition |
|
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.