Meta Developers

It operates with HandGrabPoses to specify the final pose of the hand and manipulate the objects via IMovements in order to attract them, use them at a distance, etc. The DistanceHandGrabInteractor uses DistantCandidateComputer<TInteractor, TInteractable> to detect far-away interactables.

Properties

IHand Hand[Get]

Implementation of IHandGrabInteractor.Hand; for details, please refer to the related documentation provided for that interface.

IThrowVelocityCalculator VelocityCalculator[Get]

Obsolete: this was used to get and set the interactor's IThrowVelocityCalculator, which is deprecated.

Velocity calculation capabilities are now a feature of Grabbable and should be controlled from there.

IMovement Movement[Get]

The IMovement generated as a result of interacting with an interactable.

This is created by the interactable's DistanceHandGrabInteractable.MovementProvider.

bool MovementFinished[Get]

Indicates whether or not the current Movement has finished.

HandGrabTarget HandGrabTarget[Get]

The HandGrabTarget used by this interactor when grabbing.

Transform WristPoint[Get]

Implementation of IHandGrabInteractor.WristPoint; for details, please refer to the related documentation provided for that interface.

Transform PinchPoint[Get]

Implementation of IHandGrabInteractor.PinchPoint; for details, please refer to the related documentation provided for that interface.

Transform PalmPoint[Get]

Implementation of IHandGrabInteractor.PalmPoint; for details, please refer to the related documentation provided for that interface.

HandGrabAPI HandGrabApi[Get]

Implementation of IHandGrabInteractor.HandGrabApi; for details, please refer to the related documentation provided for that interface.

GrabTypeFlags SupportedGrabTypes[Get]

Implementation of IHandGrabInteractor.SupportedGrabTypes; for details, please refer to the related documentation provided for that interface.

IHandGrabInteractable TargetInteractable[Get]

Implementation of IHandGrabInteractor.TargetInteractable; for details, please refer to the related documentation provided for that interface.

Pose Origin[Get]

Retrieves the pose (position and orientation) from which distance grabbing is calculated.

This value comes from the DistantCandidateComputer<TInteractor, TInteractable>, but conceptually it is a point relative to the hand around which it feels natural for the hand to grab.

Vector3 HitPoint[Get]

The point in space from which the interactor is considered to have "hit" its current interactable.

This is conceptually similar to RayInteractor.CollisionInfo, though the it is not the result of a simple raycast and instead results from calculations in the DistantCandidateComputer<TInteractor, TInteractable>.

IRelativeToRef DistanceInteractable[Get]

Retrieves the current interactable (null if this interactor isn't interacting with anything) as an IRelativeToRef.

This is primarily used for visualizations.

bool IsGrabbing[Get]

Implementation of IHandGrabState.IsGrabbing; for details, please refer to the related documentation provided for that interface.

float FingersStrength[Get]

Implementation of IHandGrabState.FingersStrength; for details, please refer to the related documentation provided for that interface.

float WristStrength[Get]

Implementation of IHandGrabState.WristStrength; for details, please refer to the related documentation provided for that interface.

Pose WristToGrabPoseOffset[Get]

Implementation of IHandGrabState.WristToGrabPoseOffset; for details, please refer to the related documentation provided for that interface.

Member Functions

HandFingerFlags GrabbingFingers ( )

Implementation of IHandGrabState.GrabbingFingers; for details, please refer to the related documentation provided for that interface.

override bool CanSelect

( DistanceHandGrabInteractable interactable )

Overrides Interactor<TInteractor, TInteractable>.CanSelect(TInteractable), augmenting the behavior of that base method with an additional call to HandGrabInteraction.CanInteractWith(IHandGrabInteractor, IHandGrabInteractable), which confirms the presence of hand-specific requirements for valid hand interaction.

Parameters

interactable

The interactable

Returns

True if it is possible for this interactable to select interactable , false otherwise

void InjectAllDistanceHandGrabInteractor

( HandGrabAPI handGrabApi,

DistantCandidateComputer< DistanceHandGrabInteractor, DistanceHandGrabInteractable > distantCandidateComputer,

Transform grabOrigin,

IHand hand,

GrabTypeFlags supportedGrabTypes )

Convenience method combining InjectHandGrabApi(HandGrabAPI), InjectDistantCandidateComputer(DistantCandidateComputer<DistanceHandGrabInteractor, DistanceHandGrabInteractable>), InjectGrabOrigin(Transform), /// InjectHand(IHand), and InjectSupportedGrabTypes(GrabTypeFlags).