Class TeleportVolumeDestinationSettings

Settings for evaluating the destination anchor for a TeleportationMultiAnchorVolume.

Inheritance

object

TeleportVolumeDestinationSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[Serializable]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class TeleportVolumeDestinationSettings

Properties

destinationEvaluationDelayTime

The amount of time, in seconds, for which the user must hover over the volume before it designates a destination anchor. Only used if enableDestinationEvaluationDelay is true.

Declaration

public float destinationEvaluationDelayTime { get; set; }

Property Value

Type	Description
float

See Also

enableDestinationEvaluationDelay

destinationEvaluationFilter

The filter used to evaluate a teleportation destination from the list of anchors. If this is null, the volume will use a FurthestTeleportationAnchorFilter to evaluate the destination.

Declaration

public ITeleportationVolumeAnchorFilter destinationEvaluationFilter { get; set; }

Property Value

Type	Description
ITeleportationVolumeAnchorFilter

destinationFilterObject

The object reference to the filter used to evaluate a teleportation destination. This object should implement the ITeleportationVolumeAnchorFilter interface. If this object is null, the volume will use a FurthestTeleportationAnchorFilter to evaluate the destination.

Declaration

public Object destinationFilterObject { get; set; }

Property Value

Type	Description
Object

Remarks

To access and modify the destination filter at runtime, the destinationEvaluationFilter property should be used instead.

destinationPollFrequency

The amount of time, in seconds, between queries to the destinationEvaluationFilter for its calculated destination anchor. Only used if pollForDestinationChange is true.

Declaration

public float destinationPollFrequency { get; set; }

Property Value

Type	Description
float

See Also

pollForDestinationChange

enableDestinationEvaluationDelay

Whether to delay evaluation of the destination anchor until the user has hovered over the volume for a certain amount of time.

Declaration

public bool enableDestinationEvaluationDelay { get; set; }

Property Value

Type	Description
bool

See Also

destinationEvaluationDelayTime

pollForDestinationChange

Whether to periodically query the destinationEvaluationFilter for its calculated destination anchor. If the determined anchor is different from the current destinationAnchor, the volume will initiate re-evaluation of the destination anchor.

Declaration

public bool pollForDestinationChange { get; set; }

Property Value

Type	Description
bool

See Also

destinationPollFrequency