API reference
SnapInteractor Class
SnapInteractors can snap to poses provided by SnapInteractables.
SnapInteractors select and unselect in response to a IPointableElement. SnapInteractors hover when the IPointableElement has selecting pointers and snap to the best SnapInteractable pose when the IPointableElement has no more selecting pointers.
Fields
IPointableElement PointableElement[Get]
This IPointableElement will trigger the snap interaction.
This interactor will listen to select and unselect events from this element, and begin the snap interaction in response to these events.
Rigidbody Rigidbody[Get]
The Rigidbody of the interactor object.
Pose SnapPose[Get]
This is the source pose that will be snapped to the SnapInteractable target.
By default this will be the Pose of this GameObject's transform, but can be another transform's pose if a _snapPoseTransform is provided. An example usage of this is a vase which should be snapped to a table using a point on its base, rather than the center of the vase object.
Properties
float DistanceThreshold[Get]
Used to determine which object should snap to your hand when there are multiple to choose from.
Objects with a lower threshold have a higher priority.
Protected Functions
virtual override void Awake ( )
virtual override void Start ( )
virtual override void OnEnable ( )
virtual override void OnDisable ( )
virtual override bool ComputeShouldSelect ( )
virtual override bool ComputeShouldUnselect ( )
virtual override void DoHoverUpdate ( )
virtual override void DoSelectUpdate ( )
override void InteractableSet
( SnapInteractable interactable )
override void InteractableUnset
( SnapInteractable interactable )
override void InteractableSelected
( SnapInteractable interactable )
override void InteractableUnselected
( SnapInteractable interactable )
virtual void HandlePointerEventRaised
( PointerEvent evt )
virtual override void DoPreprocess ( )
Pose ComputePointerPose ( )
virtual override SnapInteractable ComputeCandidate ( )
Member Functions
void InjectAllSnapInteractor
( PointableElement pointableElement,
Rigidbody rigidbody )
Sets all required values for a <cref="SnapInteractor" /> on a dynamically instantiated GameObject.
void InjectPointableElement
( PointableElement pointableElement )
Sets a <cref="PointableElement" /> on a dynamically instantiated GameObject.
void InjectRigidbody
( Rigidbody rigidbody )
Sets a Rigidbody on a dynamically instantiated GameObject.
void InjectOptionalSnapPoseTransform
( Transform snapPoint )
Sets a snap point on a dynamically instantiated GameObject.
void InjectOptionalTimeOutInteractable
( SnapInteractable interactable )
Sets a time out interactable on a dynamically instantiated GameObject.
void InjectOptionaTimeOut
( float timeOut )
Sets a timeout on a dynamically instantiated GameObject.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta