API reference

HandGrabUtils Class

Static Methods

CreateHandGrabInteractable ( parent , name )	Creates a new HandGrabInteractable under the given object. Signature static HandGrabInteractable CreateHandGrabInteractable(Transform parent, string name=null) Parameters `parent: Transform` The relative object for the interactable `name: string` Name for the GameObject holding this interactable Returns `HandGrabInteractable` An non-populated HandGrabInteractable
CreateHandGrabPose ( parent , relativeTo )	Signature static HandGrabPose CreateHandGrabPose(Transform parent, Transform relativeTo) Parameters `parent: Transform` `relativeTo: Transform` Returns `HandGrabPose`
LoadData ( interactable , data )	Populates the HandGrabInteractable with the serialized data version. Signature static void LoadData(HandGrabInteractable interactable, HandGrabInteractableData data) Parameters `interactable: HandGrabInteractable` `data: HandGrabInteractableData` The serialized data for the HandGrabInteractable. Returns `void`
LoadHandGrabPose ( interactable , poseData )	Signature static HandGrabPose LoadHandGrabPose(HandGrabInteractable interactable, HandGrabPoseData poseData) Parameters `interactable: HandGrabInteractable` `poseData: HandGrabPoseData` Returns `HandGrabPose`
MirrorHandGrabPose ( originalPoint , mirrorPoint , relativeTo )	Generates a new HandGrabPoseData that mirrors the provided one. Left hand becomes right hand and vice-versa. The mirror axis is defined by the surface of the snap point, if any, if none a best-guess is provided but note that it can then moved manually in the editor. Signature static void MirrorHandGrabPose(HandGrabPose originalPoint, HandGrabPose mirrorPoint, Transform relativeTo) Parameters `originalPoint: HandGrabPose` The point to mirror `mirrorPoint: HandGrabPose` The target HandGrabPose to set as mirrored of the originalPoint `relativeTo: Transform` Returns `void`
SaveData ( interactable )	Serializes the data of the HandGrabInteractable so it can be stored. Signature static HandGrabInteractableData SaveData(HandGrabInteractable interactable) Parameters `interactable: HandGrabInteractable` Returns `HandGrabInteractableData` The struct data to recreate the interactable

Inner Structs

HandGrabInteractableData Struct

Serializable data-only version of the HandGrabInteractable so it can be stored when they are generated at Play-Mode (where Hand-tracking works).

This can be used by Unity Editor-based tools such as the HandGrabPoseWizard in order to persist state collected during Play-Mode for use after that Play-Mode session.

grabType : GrabTypeFlags	Copy of the source interactor's HandGrabInteractable.SupportedGrabTypes; for details, please refer to the related documentation provided for that property. Signature GrabTypeFlags grabType
handAlignment : HandAlignType	Copy of the source interactor's HandGrabInteractable.HandAlignment; for details, please refer to the related documentation provided for that property. Signature HandAlignType handAlignment
palmGrabRules : GrabbingRule	Copy of the source interactor's HandGrabInteractable.PalmGrabRules; for details, please refer to the related documentation provided for that property. Signature GrabbingRule palmGrabRules
pinchGrabRules : GrabbingRule	Copy of the source interactor's HandGrabInteractable.PinchGrabRules; for details, please refer to the related documentation provided for that property. Signature GrabbingRule pinchGrabRules
poses : List< HandGrabPoseData >	Copy of the source interactor's HandGrabInteractable.HandGrabPoses; for details, please refer to the related documentation provided for that property. Signature List<HandGrabPoseData> poses
scoringModifier : PoseMeasureParameters	Copy of the source interactor's HandGrabInteractable.ScoreModifier; for details, please refer to the related documentation provided for that property. Signature PoseMeasureParameters scoringModifier

gripPose : Pose	Signature Pose gripPose
handPose : HandPose	Signature HandPose handPose
scale : float	Signature float scale

HandGrabUtils Class

Static Methods

Inner Structs

HandGrabInteractableData Struct

Fields

HandGrabPoseData Struct

Fields