HandInteractionHint Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This class provides wrapper functionality for triggering animations and fades for the hand rig.
public ref class HandInteractionHint : UnityEngine::MonoBehaviour
public class HandInteractionHint : UnityEngine.MonoBehaviour
type HandInteractionHint = class
inherit MonoBehaviour
Public Class HandInteractionHint
Inherits MonoBehaviour
- Inheritance
-
UnityEngine.MonoBehaviourHandInteractionHint
Constructors
HandInteractionHint() |
Fields
CustomShouldHideVisuals |
Custom function to determine visibility of visuals. Return true to hide visuals and reset min timer (max timer will still be in effect), return false when user is doing nothing and needs a hint. |
Properties
AnimationState |
Name of animation to play during loop. |
AutoActivate |
If true, logic runs whenever this component is active. If false, you must manually start the logic with StartShowTimer. |
HideIfHandTracked |
React to hand tracking state to hide visuals when hands are being tracked. If false, only the customShouldHideHands function will be evaluated. |
MaxDelay |
Max delay for showing the visuals. If the user's hands are in view, the min timer will reset to 0, but the visuals will appear after max seconds. |
MinDelay |
Min delay for showing the visuals. If the user's hands are not in view, the visuals will appear after min seconds. |
RepeatDelay |
Time to wait between repeats in seconds. |
Repeats |
Number of times to repeat the hint before fading out and waiting for timer again. |
UseMaxDelay |
Set to false if you don't want to use a max timer and only want to show the hint when user's hands are not tracked. |
VisualsRoot |
Methods
GetAnimationDuration(String) |
Gets the duration of the animation name passed in, or 0 if the state name is not found. |
StartHintLoop() |
Starts the hint loop logic. |
StopHintLoop() |
Fades out the hint and stops the hint loop logic |