API reference

HandGrabPose Class

Extends MonoBehaviour
The HandGrabPose defines the local point in an object to which the grip point of the hand should align.
It can also contain information about the final pose of the hand for perfect alignment as well as a surface that indicates the valid positions for the point.

Properties

HandPose : HandPose
[Get]
Signature
HandPose HandPose
RelativePose : Pose
[Get]
Pose of the HandGrabPose relative to its reference transform.
Signature
Pose RelativePose
RelativeScale : float
[Get]
Scale of the HandGrabPoint relative to its reference transform.
Signature
float RelativeScale
RelativeTo : Transform
[Get]
Reference transform of the HandGrabPose.
Signature
Transform RelativeTo
SnapSurface : IGrabSurface
[Get]
Signature
IGrabSurface SnapSurface

Protected Methods

Awake ()
Signature
virtual void Awake()
Returns
void
Reset ()
Signature
virtual void Reset()
Returns
void

Methods

CalculateBestPose ( userPose , handedness , scoringModifier , relativeTo , result )
Signature
virtual bool CalculateBestPose(Pose userPose, Handedness handedness, PoseMeasureParameters scoringModifier, Transform relativeTo, ref HandGrabResult result)
Parameters
userPose: Pose
handedness: Handedness
scoringModifier: PoseMeasureParameters
relativeTo: Transform
result: ref HandGrabResult
Returns
bool
CalculateBestPose ( userPose , offset , relativeTo , handedness , scoringModifier , result )
Signature
virtual void CalculateBestPose(in Pose userPose, in Pose offset, Transform relativeTo, Handedness handedness, PoseMeasureParameters scoringModifier, ref HandGrabResult result)
Parameters
userPose: in Pose
offset: in Pose
relativeTo: Transform
handedness: Handedness
scoringModifier: PoseMeasureParameters
result: ref HandGrabResult
Returns
void
InjectAllHandGrabPose ( relativeTo )
Signature
void InjectAllHandGrabPose(Transform relativeTo)
Parameters
relativeTo: Transform
Returns
void
InjectOptionalHandPose ( handPose )
Signature
void InjectOptionalHandPose(HandPose handPose)
Parameters
handPose: HandPose
Returns
void
InjectOptionalSurface ( surface )
Signature
void InjectOptionalSurface(IGrabSurface surface)
Parameters
surface: IGrabSurface
Returns
void
InjectRelativeTo ( relativeTo )
Signature
void InjectRelativeTo(Transform relativeTo)
Parameters
relativeTo: Transform
Returns
void
UsesHandPose ()
Signature
bool UsesHandPose()
Returns
bool