API reference
API reference
Select your platform
No SDKs available
No versions available

DistanceHandGrabInteractable Class

The DistanceHandGrabInteractable allows grabbing the marked object from far away.
Internally it uses HandGrabPoses to specify not only the poses of the hands but the required gestures to perform the grab. It is possible (and recommended) to reuse the same HandGrabPoses used by the HandGrabInteractable, and even select just a few so they become the default poses when distant grabbing.

Properties

Colliders : Collider[]
[Get]
Signature
Collider [] Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.Colliders
HandAlignment : HandAlignType
[Get][Set]
Signature
HandAlignType Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.HandAlignment
HandGrabPoses : List< HandGrabPose >
[Get]
Signature
List<HandGrabPose> Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.HandGrabPoses
MovementProvider : IMovementProvider
[Get][Set]
Signature
IMovementProvider Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.MovementProvider
PalmGrabRules : GrabbingRule
[Get]
Signature
GrabbingRule Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.PalmGrabRules
PinchGrabRules : GrabbingRule
[Get]
Signature
GrabbingRule Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.PinchGrabRules
RelativeTo : Transform
[Get]
General getter for the transform of the object this interactable refers to.
Signature
Transform Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.RelativeTo
ResetGrabOnGrabsUpdated : bool
[Get][Set]
Signature
bool Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.ResetGrabOnGrabsUpdated
Rigidbody : Rigidbody
[Get]
Signature
Rigidbody Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.Rigidbody
Slippiness : float
[Get][Set]
Signature
float Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.Slippiness
SupportedGrabTypes : GrabTypeFlags
[Get]
Signature
GrabTypeFlags Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.SupportedGrabTypes
UsesHandPose : bool
[Get]
Signature
bool Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.UsesHandPose

Protected Methods

Awake ()
Signature
override void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.Awake()
Returns
override void
Reset ()
Signature
virtual void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.Reset()
Returns
void
Start ()
Signature
override void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.Start()
Returns
override void

Methods

ApplyVelocities ( linearVelocity , angularVelocity )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.ApplyVelocities(Vector3 linearVelocity, Vector3 angularVelocity)
Parameters
linearVelocity: Vector3
angularVelocity: Vector3
Returns
void
CalculateBestPose ( userPose , handScale , handedness , result )
Signature
bool Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.CalculateBestPose(Pose userPose, float handScale, Handedness handedness, ref HandGrabResult result)
Parameters
userPose: Pose
handScale: float
handedness: Handedness
result: ref HandGrabResult
Returns
bool
CalculateBestPose ( userPose , offset , relativeTo , handScale , handedness , result )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.CalculateBestPose(in Pose userPose, in Pose offset, Transform relativeTo, float handScale, Handedness handedness, ref HandGrabResult result)
Parameters
userPose: in Pose
offset: in Pose
relativeTo: Transform
handScale: float
handedness: Handedness
result: ref HandGrabResult
Returns
void
GenerateMovement ( from , to )
Signature
IMovement Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.GenerateMovement(in Pose from, in Pose to)
Parameters
from: in Pose
to: in Pose
Returns
IMovement
InjectAllDistanceHandGrabInteractable ( supportedGrabTypes , rigidbody , pinchGrabRules , palmGrabRules )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectAllDistanceHandGrabInteractable(GrabTypeFlags supportedGrabTypes, Rigidbody rigidbody, GrabbingRule pinchGrabRules, GrabbingRule palmGrabRules)
Parameters
supportedGrabTypes: GrabTypeFlags
rigidbody: Rigidbody
pinchGrabRules: GrabbingRule
palmGrabRules: GrabbingRule
Returns
void
InjectOptionalHandGrabPoses ( handGrabPoses )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectOptionalHandGrabPoses(List< HandGrabPose > handGrabPoses)
Parameters
handGrabPoses: List< HandGrabPose >
Returns
void
InjectOptionalMovementProvider ( provider )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectOptionalMovementProvider(IMovementProvider provider)
Parameters
Returns
void
InjectOptionalPhysicsGrabbable ( physicsObject )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectOptionalPhysicsGrabbable(PhysicsGrabbable physicsObject)
Parameters
physicsObject: PhysicsGrabbable
Returns
void
InjectPalmGrabRules ( palmGrabRules )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectPalmGrabRules(GrabbingRule palmGrabRules)
Parameters
palmGrabRules: GrabbingRule
Returns
void
InjectPinchGrabRules ( pinchGrabRules )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectPinchGrabRules(GrabbingRule pinchGrabRules)
Parameters
pinchGrabRules: GrabbingRule
Returns
void
InjectRigidbody ( rigidbody )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectRigidbody(Rigidbody rigidbody)
Parameters
rigidbody: Rigidbody
Returns
void
InjectSupportedGrabTypes ( supportedGrabTypes )
Signature
void Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.InjectSupportedGrabTypes(GrabTypeFlags supportedGrabTypes)
Parameters
supportedGrabTypes: GrabTypeFlags
Returns
void
SupportsHandedness ( handedness )
Signature
bool Oculus.Interaction.HandGrab.DistanceHandGrabInteractable.SupportsHandedness(Handedness handedness)
Parameters
handedness: Handedness
Returns
bool