HandInteractionHint Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.UI.HandCoach

Assembly:

Microsoft.MixedReality.Toolkit.SDK.dll

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.MonoBehaviour

HandInteractionHint

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.
HintDisplayDelay	When the user's hands are not in view, the visuals will appear after HintDisplayDelay 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.
TrackedHandHintDisplayDelay	When the user's hands are in view, the visuals will appear after TrackedHandHintDisplayDelay seconds."
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