FollowMeToggle Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.UI

Assembly:

Microsoft.MixedReality.Toolkit.SDK.dll

A utility script for toggling the 'Follow Me' behavior by activating/deactivating the Radial View Solver. This script also provides optional toggle at specified distance.

public ref class FollowMeToggle : UnityEngine::MonoBehaviour

[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/FollowMeToggle")]
[UnityEngine.RequireComponent(typeof(Microsoft.MixedReality.Toolkit.Utilities.Solvers.RadialView))]
public class FollowMeToggle : UnityEngine.MonoBehaviour

[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/FollowMeToggle")>]
[<UnityEngine.RequireComponent(typeof(Microsoft.MixedReality.Toolkit.Utilities.Solvers.RadialView))>]
type FollowMeToggle = class
    inherit MonoBehaviour

Public Class FollowMeToggle
Inherits MonoBehaviour

Inheritance

UnityEngine.MonoBehaviour

FollowMeToggle

Attributes

UnityEngine.AddComponentMenuAttribute UnityEngine.RequireComponentAttribute

Constructors

FollowMeToggle()

Properties

AutoFollowAtDistance	Should following be automatically enabled when the user is further than a certain distance away?
AutoFollowDistance	If autoFollowAtDistance is enabled, what distance to trigger auto following at.
AutoFollowTransformTarget	Optional transform to use when using autoFollowAtDistance. If not specified the local transform is used.
AutoFollowTriggered	Event that gets fired when auto follow is triggered.
ButtonBehavior	A way to indicate how should interactable react to the follow behavior state.
InteractableObject	An optional Interactable to select/deselect when toggling the follow behavior.
VisualizationObject	An optional object for visualizing the 'Follow Me' mode state.

Methods

SetFollowMeBehavior(Boolean)	Enables or disables the solver based on the follow parameter.
ToggleFollowMeBehavior()	Toggles the current follow behavior of the solver.