Class FollowMeToggle

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.

Inheritance

Object

FollowMeToggle

Namespace: Microsoft.MixedReality.Toolkit.UI

Assembly: cs.temp.dll.dll

Syntax

public class FollowMeToggle : MonoBehaviour

Properties

AutoFollowAtDistance

Should following be automatically enabled when the user is further than a certain distance away?

Declaration

public bool AutoFollowAtDistance { get; set; }

Property Value

Type	Description
Boolean

AutoFollowDistance

If autoFollowAtDistance is enabled, what distance to trigger auto following at.

Declaration

public float AutoFollowDistance { get; set; }

Property Value

Type	Description
Single

AutoFollowTransformTarget

Optional transform to use when using autoFollowAtDistance. If not specified the local transform is used.

Declaration

public Transform AutoFollowTransformTarget { get; set; }

Property Value

Type	Description
Transform

InteractableObject

An optional Interactable to select/deselect when toggling the follow behavior.

Declaration

public Interactable InteractableObject { get; set; }

Property Value

Type	Description
Interactable

VisualizationObject

An optional object for visualizing the 'Follow Me' mode state.

Declaration

public GameObject VisualizationObject { get; set; }

Property Value

Type	Description
GameObject

Methods

SetFollowMeBehavior(Boolean)

Enables or disables the solver based on the follow parameter.

Declaration

public void SetFollowMeBehavior(bool follow)

Parameters

Type	Name	Description
Boolean	follow	True if the solver should be active.

ToggleFollowMeBehavior()

Toggles the current follow behavior of the solver.

Declaration

public void ToggleFollowMeBehavior()