{"_id":"5b1f8e259c68300003297a49","project":"571fa55ca0acd42000af9545","version":{"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mangalica","version_clean":"3.3.0","version":"3.3.0"},"category":{"_id":"5b1f8576c2505d0003125425","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-31T16:56:01.612Z","from_sync":false,"order":1,"slug":"prefabs","title":"Prefabs"},"user":"571fa519db52d01700f5cf3d","githubsync":"","__v":1,"parentDoc":null,"updates":["5bd68d908f8b97002378921a"],"next":{"pages":[],"description":""},"createdAt":"2018-06-12T09:11:01.687Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":15,"body":"## Overview\n\nProvides a custom controller hand model with psuedo finger functionality.\n\n**Prefab Usage:**\n * Place the `VRTK/Prefabs/AvatarHands/BasicHands/VRTK_BasicHand` prefab as a child of either the left or right script alias.\n * If the prefab is being used in the left hand then check the `Mirror Model` parameter.\n * By default, the avatar hand controller will detect which controller is connected and represent it accordingly.\n * Optionally, use SDKTransformModify scripts to adjust the hand orientation based on different controller types.\n\n## Inspector Parameters\n\n * **Ignore All Overrides:** Determines whether to ignore all of the given overrides on an Interaction event.\n * **State Value:** Sets the Animation parameter for the interaction type and can be used to change the Idle pose based on interaction type.\n * **Apply Thumb Override:** Determines when to apply the given thumb override.\n * **Thumb Override:** The axis override for the thumb on an Interact Touch event. Will only be applicable if the thumb button state is not touched.\n * **Apply Index Override:** Determines when to apply the given index finger override.\n * **Index Override:** The axis override for the index finger on an Interact Touch event. Will only be applicable if the index finger button state is not touched.\n * **Apply Middle Override:** Determines when to apply the given middle finger override.\n * **Middle Override:** The axis override for the middle finger on an Interact Touch event. Will only be applicable if the middle finger button state is not touched.\n * **Apply Ring Override:** Determines when to apply the given ring finger override.\n * **Ring Override:** The axis override for the ring finger on an Interact Touch event. Will only be applicable if the ring finger button state is not touched.\n * **Apply Pinky Override:** Determines when to apply the given pinky finger override.\n * **Pinky Override:** The axis override for the pinky finger on an Interact Touch event.  Will only be applicable if the pinky finger button state is not touched.\n * **Controller Type:** The controller type to use for default finger settings.\n * **Set Fingers For Controller Type:** Determines whether the Finger and State settings are auto set based on the connected controller type.\n * **Mirror Model:** If this is checked then the model will be mirrored, tick this if the avatar hand is for the left hand controller.\n * **Animation Snap Speed:** The speed in which a finger will transition to it's destination position if the finger state is `Digital`.\n * **Thumb Button:** The button alias to control the thumb if the thumb state is `Digital`.\n * **Index Button:** The button alias to control the index finger if the index finger state is `Digital`.\n * **Middle Button:** The button alias to control the middle finger if the middle finger state is `Digital`.\n * **Ring Button:** The button alias to control the ring finger if the ring finger state is `Digital`.\n * **Pinky Button:** The button alias to control the pinky finger if the pinky finger state is `Digital`.\n * **Three Finger Button:** The button alias to control the middle, ring and pinky finger if the three finger state is `Digital`.\n * **Thumb Axis Button:** The button type to listen for axis changes to control the thumb.\n * **Index Axis Button:** The button type to listen for axis changes to control the index finger.\n * **Middle Axis Button:** The button type to listen for axis changes to control the middle finger.\n * **Ring Axis Button:** The button type to listen for axis changes to control the ring finger.\n * **Pinky Axis Button:** The button type to listen for axis changes to control the pinky finger.\n * **Three Finger Axis Button:** The button type to listen for axis changes to control the middle, ring and pinky finger.\n * **Thumb State:** The Axis Type to utilise when dealing with the thumb state. Not all controllers support all axis types on all of the available buttons.\n * **Near Touch Overrides:** Finger axis overrides on an Interact NearTouch event.\n * **Touch Overrides:** Finger axis overrides on an Interact Touch event.\n * **Grab Overrides:** Finger axis overrides on an Interact Grab event.\n * **Use Overrides:** Finger axis overrides on an Interact Use event.\n * **Hand Model:** The Transform that contains the avatar hand model. If this is left blank then a child GameObject named `Model` will be searched for to use as the Transform.\n * **Controller Events:** The controller to listen for the events on. If this is left blank as it will be auto populated by finding the Controller Events script on the parent GameObject.\n * **Interact Near Touch:** An optional Interact NearTouch to listen for near touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact NearTouch script on the parent GameObject.\n * **Interact Touch:** An optional Interact Touch to listen for touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact Touch script on the parent GameObject.\n * **Interact Grab:** An optional Interact Grab to listen for grab events on. If this is left blank as it will attempt to be auto populated by finding the Interact Grab script on the parent GameObject.\n * **Interact Use:** An optional Interact Use to listen for use events on. If this is left blank as it will attempt to be auto populated by finding the Interact Use script on the parent GameObject.\n\n## Class Variables\n\n * `public enum ApplyOverrideType` - Determine when to apply the override.\n   * `Never` - Never apply the override.\n   * `Always` - Always apply the override.\n   * `DigitalState` - Only apply the override when the state is set to digital.\n   * `AxisState` - Only apply the override when the state is set to axis.\n   * `SenseAxisState` - Only apply the override when the state is set to sense axis.\n   * `AxisAndSenseAxisState` - Only apply the override when the state is set to axis or sense axis.\n\n## Example\n\n`032_Controller_CustomControllerModel` uses the `VRTK_BasicHand` prefab to display custom avatar hands for the left and right controller.","excerpt":"","slug":"avatar-hand-controller","type":"basic","title":"Avatar Hand Controller"}

Avatar Hand Controller


## Overview Provides a custom controller hand model with psuedo finger functionality. **Prefab Usage:** * Place the `VRTK/Prefabs/AvatarHands/BasicHands/VRTK_BasicHand` prefab as a child of either the left or right script alias. * If the prefab is being used in the left hand then check the `Mirror Model` parameter. * By default, the avatar hand controller will detect which controller is connected and represent it accordingly. * Optionally, use SDKTransformModify scripts to adjust the hand orientation based on different controller types. ## Inspector Parameters * **Ignore All Overrides:** Determines whether to ignore all of the given overrides on an Interaction event. * **State Value:** Sets the Animation parameter for the interaction type and can be used to change the Idle pose based on interaction type. * **Apply Thumb Override:** Determines when to apply the given thumb override. * **Thumb Override:** The axis override for the thumb on an Interact Touch event. Will only be applicable if the thumb button state is not touched. * **Apply Index Override:** Determines when to apply the given index finger override. * **Index Override:** The axis override for the index finger on an Interact Touch event. Will only be applicable if the index finger button state is not touched. * **Apply Middle Override:** Determines when to apply the given middle finger override. * **Middle Override:** The axis override for the middle finger on an Interact Touch event. Will only be applicable if the middle finger button state is not touched. * **Apply Ring Override:** Determines when to apply the given ring finger override. * **Ring Override:** The axis override for the ring finger on an Interact Touch event. Will only be applicable if the ring finger button state is not touched. * **Apply Pinky Override:** Determines when to apply the given pinky finger override. * **Pinky Override:** The axis override for the pinky finger on an Interact Touch event. Will only be applicable if the pinky finger button state is not touched. * **Controller Type:** The controller type to use for default finger settings. * **Set Fingers For Controller Type:** Determines whether the Finger and State settings are auto set based on the connected controller type. * **Mirror Model:** If this is checked then the model will be mirrored, tick this if the avatar hand is for the left hand controller. * **Animation Snap Speed:** The speed in which a finger will transition to it's destination position if the finger state is `Digital`. * **Thumb Button:** The button alias to control the thumb if the thumb state is `Digital`. * **Index Button:** The button alias to control the index finger if the index finger state is `Digital`. * **Middle Button:** The button alias to control the middle finger if the middle finger state is `Digital`. * **Ring Button:** The button alias to control the ring finger if the ring finger state is `Digital`. * **Pinky Button:** The button alias to control the pinky finger if the pinky finger state is `Digital`. * **Three Finger Button:** The button alias to control the middle, ring and pinky finger if the three finger state is `Digital`. * **Thumb Axis Button:** The button type to listen for axis changes to control the thumb. * **Index Axis Button:** The button type to listen for axis changes to control the index finger. * **Middle Axis Button:** The button type to listen for axis changes to control the middle finger. * **Ring Axis Button:** The button type to listen for axis changes to control the ring finger. * **Pinky Axis Button:** The button type to listen for axis changes to control the pinky finger. * **Three Finger Axis Button:** The button type to listen for axis changes to control the middle, ring and pinky finger. * **Thumb State:** The Axis Type to utilise when dealing with the thumb state. Not all controllers support all axis types on all of the available buttons. * **Near Touch Overrides:** Finger axis overrides on an Interact NearTouch event. * **Touch Overrides:** Finger axis overrides on an Interact Touch event. * **Grab Overrides:** Finger axis overrides on an Interact Grab event. * **Use Overrides:** Finger axis overrides on an Interact Use event. * **Hand Model:** The Transform that contains the avatar hand model. If this is left blank then a child GameObject named `Model` will be searched for to use as the Transform. * **Controller Events:** The controller to listen for the events on. If this is left blank as it will be auto populated by finding the Controller Events script on the parent GameObject. * **Interact Near Touch:** An optional Interact NearTouch to listen for near touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact NearTouch script on the parent GameObject. * **Interact Touch:** An optional Interact Touch to listen for touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact Touch script on the parent GameObject. * **Interact Grab:** An optional Interact Grab to listen for grab events on. If this is left blank as it will attempt to be auto populated by finding the Interact Grab script on the parent GameObject. * **Interact Use:** An optional Interact Use to listen for use events on. If this is left blank as it will attempt to be auto populated by finding the Interact Use script on the parent GameObject. ## Class Variables * `public enum ApplyOverrideType` - Determine when to apply the override. * `Never` - Never apply the override. * `Always` - Always apply the override. * `DigitalState` - Only apply the override when the state is set to digital. * `AxisState` - Only apply the override when the state is set to axis. * `SenseAxisState` - Only apply the override when the state is set to sense axis. * `AxisAndSenseAxisState` - Only apply the override when the state is set to axis or sense axis. ## Example `032_Controller_CustomControllerModel` uses the `VRTK_BasicHand` prefab to display custom avatar hands for the left and right controller.