docs.unity3d.com
    Show / Hide Table of Contents

    Class XRDistanceEvaluator

    Evaluates the Interactor distance from the target Interactable. Targets close to the Interactor will receive a highest score and targets far way will receive a lower score.

    Inheritance
    Object
    XRTargetEvaluator
    XRDistanceEvaluator
    Inherited Members
    XRTargetEvaluator.filter
    XRTargetEvaluator.enabled
    XRTargetEvaluator.weight
    XRTargetEvaluator.disposed
    XRTargetEvaluator.Awake()
    XRTargetEvaluator.OnDispose()
    XRTargetEvaluator.OnEnable()
    XRTargetEvaluator.OnDisable()
    XRTargetEvaluator.GetWeightedScore(IXRInteractor, IXRInteractable)
    XRTargetEvaluator.Dispose()
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.Interaction.Toolkit.Filtering
    Syntax
    [Serializable]
    public class XRDistanceEvaluator : XRTargetEvaluator, IDisposable

    Properties

    maxDistance

    The maximum distance from the Interactor. Any target from this distance will receive a 0 normalized score.

    Declaration
    public float maxDistance { get; set; }
    Property Value
    Type Description
    Single

    Methods

    CalculateNormalizedScore(IXRInteractor, IXRInteractable)

    Calculates and returns a normalized value that represents the intention to select the given target Interactable.
    The highest score of 1 represents the intention to select the given target and the lowest score of 0 the intention to not select it, any value in between is valid.

    Declaration
    protected override float CalculateNormalizedScore(IXRInteractor interactor, IXRInteractable target)
    Parameters
    Type Name Description
    IXRInteractor interactor

    The Interactor whose Interactable targets (candidates) are being evaluated.

    IXRInteractable target

    The target Interactable to evaluate the normalized score.

    Returns
    Type Description
    Single

    Returns the normalized interaction score of the given target.
    It's a good practice to return a value between 0 and 1 inclusive and edit the weight curve to evaluate the target weighted interaction score.

    Overrides
    XRTargetEvaluator.CalculateNormalizedScore(IXRInteractor, IXRInteractable)
    Remarks

    This is similar to the implementation of the default algorithm to get valid targets in XRDirectInteractor.

    See Also
    XRTargetFilter
    GetValidTargets(List<IXRInteractable>)

    Reset()

    (Editor Only) Unity calls this automatically when adding the evaluator to the Filter Target the first time. This function is only called in the Unity editor. Reset is most commonly used to give good default values in the Inspector.

    Declaration
    public override void Reset()
    Overrides
    XRTargetEvaluator.Reset()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023