Class GazeTeleportationAnchorFilter

Filter for a TeleportationMultiAnchorVolume that designates the anchor most aligned with the camera forward direction, optionally weighted by distance from the user, as the teleportation destination. Distance calculation uses the camera position projected onto the XZ plane of the XR Origin.

Inheritance

object

Object

ScriptableObject

GazeTeleportationAnchorFilter

Implements

ITeleportationVolumeAnchorFilter

Inherited Members

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[CreateAssetMenu(fileName = "GazeTeleportationAnchorFilter", menuName = "XR/Locomotion/Gaze Teleportation Anchor Filter")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation.GazeTeleportationAnchorFilter.html")]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class GazeTeleportationAnchorFilter : ScriptableObject, ITeleportationVolumeAnchorFilter

Properties

distanceWeightCurve

The curve used to weight an anchor's score by its distance from the user. The X axis is the normalized distance, where 0 is the distance of the closest anchor and 1 is the distance of the furthest anchor. The Y axis is the weight.

Declaration

public AnimationCurve distanceWeightCurve { get; set; }

Property Value

Type	Description
AnimationCurve

enableDistanceWeighting

Whether to weight an anchor's score by its distance from the user.

Declaration

public bool enableDistanceWeighting { get; set; }

Property Value

Type	Description
bool

gazeAngleScoreCurve

The curve used to score an anchor by its alignment with the camera forward. The X axis is the normalized angle between the camera forward and the anchor direction, where 0 is 0 degrees and 1 is maxGazeAngle degrees. The Y axis is the score. The anchor with the highest score is chosen as the destination.

Declaration

public AnimationCurve gazeAngleScoreCurve { get; set; }

Property Value

Type	Description
AnimationCurve

maxGazeAngle

The maximum angle (in degrees) between the camera forward and the direction from the camera to an anchor for the anchor to be considered a valid destination.

Declaration

public float maxGazeAngle { get; set; }

Property Value

Type	Description
float

Methods

GetDestinationAnchorIndex(TeleportationMultiAnchorVolume)

Called by the teleportationVolume to designate an anchor as the teleportation destination.

Declaration

public int GetDestinationAnchorIndex(TeleportationMultiAnchorVolume teleportationVolume)

Parameters

Type	Name	Description
TeleportationMultiAnchorVolume	teleportationVolume	The volume that is designating a destination anchor.

Returns

Type	Description
int	Returns the index of the transform in the teleportationVolume's anchors list to use as the teleportation destination. If this value is outside the range of the list, the volume will not designate a destination anchor.

Reset()

See MonoBehaviour.

Declaration

protected void Reset()

Implements

ITeleportationVolumeAnchorFilter