[AddComponentMenu("XR/Lazy Follow", 22)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.3/api/UnityEngine.XR.Interaction.Toolkit.UI.LazyFollow.html")]
public class LazyFollow : MonoBehaviour

Properties

maxAngleAllowed

The max angle offset allowed within the time threshold which decides whether or not lazy rotation capability is turned on.

Declaration

public float maxAngleAllowed { get; set; }

Property Value

Type	Description
Single

maxDistanceAllowed

The max distance allowed within the time threshold which decides whether or not lazy follow capability is turned on.

Declaration

public float maxDistanceAllowed { get; set; }

Property Value

Type	Description
Single

minAngleAllowed

The min angle offset allowed within the time threshold which decides whether or not lazy rotation capability is turned on.

Declaration

public float minAngleAllowed { get; set; }

Property Value

Type	Description
Single

minDistanceAllowed

The min distance allowed within the time threshold which decides whether or not lazy follow capability is turned on.

Declaration

public float minDistanceAllowed { get; set; }

Property Value

Type	Description
Single

movementSpeed

The laziness or smoothing that is applied to the follow movement. Higher values result in direct following, lower values will cause this object to follow more lazily.

Declaration

public float movementSpeed { get; set; }

Property Value

Type	Description
Single

snapOnEnable

Snap to target position when this component is enabled.

Declaration

public bool snapOnEnable { get; set; }

Property Value

Type	Description
Boolean

target

The object being followed. If not set, this will default to the main camera when this component is enabled.

Declaration

public Transform target { get; set; }

Property Value

Type	Description
Transform

targetOffset

The amount to offset the target's position when following. This position is relative/local to the target object.

Declaration

public Vector3 targetOffset { get; set; }

Property Value

Type	Description
Vector3

timeUntilThresholdReachesMaxAngle

The time threshold (in seconds) where if max angle change is reached the lazy follow capability will not be turned off.

Declaration

public float timeUntilThresholdReachesMaxAngle { get; set; }

Property Value

Type	Description
Single

timeUntilThresholdReachesMaxDistance

The time threshold (in seconds) where if max distance is reached the lazy follow capability will not be turned off.

Declaration

public float timeUntilThresholdReachesMaxDistance { get; set; }

Property Value

Type	Description
Single

Methods

Awake()

See MonoBehaviour.

Declaration

protected void Awake()

LateUpdate()

See MonoBehaviour.

Declaration

protected void LateUpdate()

OnDestroy()

See MonoBehaviour.

Declaration

protected void OnDestroy()

OnDisable()

See MonoBehaviour.

Declaration

protected void OnDisable()

OnEnable()

See MonoBehaviour.

Declaration

protected void OnEnable()

TryGetThresholdTargetPosition(out Vector3)

This method will only return true if the new value is within the threshold target set by the time since the last successful update.

Declaration

protected virtual bool TryGetThresholdTargetPosition(out Vector3 newTarget)

Parameters

Type	Name	Description
Vector3	newTarget	The new target position.

Returns

Type	Description
Boolean	Returns true if the new value is within the threshold target. Otherwise, returns false.

TryGetThresholdTargetRotation(out Quaternion)

This method will only return true if the new value is within the threshold target set by the time since the last successful update.

Declaration

protected virtual bool TryGetThresholdTargetRotation(out Quaternion newTarget)

Parameters

Type	Name	Description
Quaternion	newTarget	The new target rotation.

Returns

Type	Description
Boolean	Returns true if the new value is within the threshold target. Otherwise, returns false.