API reference

SnapInteractable Class

SnapInteractables provide Pose targets for SnapInteractors to translate and rotate towards.

Properties

Rigidbody Rigidbody[Get]
ISnapPoseDelegate SnapPoseDelegate[Get]
IMovementProvider MovementProvider[Get]

Protected Functions

virtual override void Awake ( )
virtual override void Start ( )
override void InteractorAdded
( SnapInteractor interactor )
override void InteractorRemoved
( SnapInteractor interactor )
override void SelectingInteractorAdded
( SnapInteractor interactor )
override void SelectingInteractorRemoved
( SnapInteractor interactor )

Member Functions

void InteractorHoverUpdated
( SnapInteractor interactor )
Moves the tracked element using the <cref="ISnapPoseDelegate" />.
bool PoseForInteractor
( SnapInteractor interactor,
out Pose result )
Sets the pose for the interactor.
Parameters
interactor
The SnapInteractor object.
result
The resulting pose.
IMovement GenerateMovement
( in Pose from,
SnapInteractor interactor )
Generates a movement that when applied will move the interactor from a start to a target pose.
Parameters
from
The starting position of the interactor.
interactor
The interactor to move.
void InjectAllSnapInteractable
( Rigidbody rigidbody )
Sets all required values for a snap interactable to a dynamically instantiated GameObject.
void InjectRigidbody
( Rigidbody rigidbody )
Sets a Rigidbody on a dynamically instantiated GameObject.
void InjectOptionalMovementProvider
( IMovementProvider provider )
Sets a movement provider on a dynamically instantiated GameObject.
void InjectOptionalSnapPoseDelegate
( ISnapPoseDelegate snapPoseDelegate )
Sets a snap pose delegate on a dynamically instantiated GameObject.