Interface IAdaptPosition
Gives decorated class ability to be automatically positioned by the AdaptivePositionModule
Syntax
public interface IAdaptPosition
Properties
adaptiveElementRepositionCoroutine
Coroutine that handles the animated re-positioning of the object
Declaration
Coroutine adaptiveElementRepositionCoroutine { get; set; }
Property Value
| Type |
Description |
| Coroutine |
|
adaptivePositionRestDistance
Target z-offset, at which to position the gaze source transform
Declaration
float adaptivePositionRestDistance { get; }
Property Value
Transform utilized by the AdaptivePositionModule to reposition this transform when the allowedGazeDivergence threshold is surpassed.
If null, the adaptivePositionModule will not manually re-position the implementor, regardless of applicable criteria
Declaration
Transform adaptiveTransform { get; }
Property Value
| Type |
Description |
| Transform |
|
allowAdaptivePositioning
Denotes if this implementer is active, and will have it's position adjusted automatically
Declaration
bool allowAdaptivePositioning { get; }
Property Value
allowedDegreeOfGazeDivergence
Declaration
float allowedDegreeOfGazeDivergence { get; }
Property Value
allowedMaxDistanceDivergence
Distance beyond which an object will be re-positioned at the ideal distance from the user's gaze/hmd
Declaration
float allowedMaxDistanceDivergence { get; }
Property Value
allowedMinDistanceDivergence
Distance below which an object will be re-positioned at the ideal distance from the user's gaze/hmd
Declaration
float allowedMinDistanceDivergence { get; }
Property Value
beingMoved
Denotes if this implementer is being moved by the AdaptivePositionModule
Declaration
Property Value
inFocus
Declaration
bool inFocus { get; set; }
Property Value
onlyMoveWhenOutOfFocus
Adjust position only when out of focus/gaze
This allows an implementer to remain stable while the user move towards/away while focusing upon it
Declaration
bool onlyMoveWhenOutOfFocus { get; }
Property Value
repositionIfOutOfFocus
Adjust position, regardless of distance, if out of focus
Declaration
bool repositionIfOutOfFocus { get; }
Property Value
resetAdaptivePosition
Bool denoting that this implementer should have its position immediately reset when the next scheduled position update occurs
Declaration
bool resetAdaptivePosition { get; set; }
Property Value
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.