docs.unity3d.com
    Show / Hide Table of Contents

    Struct DistanceInfo

    Struct used to get information back from a distance calculation between an object and a location.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public struct DistanceInfo

    Properties

    collider

    The collider associated with the point. Returns null if the distance calculation doesn't involve colliders, or if there is no valid collider for calculation.

    Declaration
    public Collider collider { readonly get; set; }
    Property Value
    Type Description
    Collider

    distanceSqr

    The distance squared between point and the location used for calculation.

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

    point

    The location on the object (in world space) where the distance was calculated from.

    Declaration
    public Vector3 point { readonly get; set; }
    Property Value
    Type Description
    Vector3
    Remarks

    When used with the method TryGetClosestPointOnCollider(IXRInteractable, Vector3, out DistanceInfo), point contains the collider's position.

    When used with the method TryGetClosestCollider(IXRInteractable, Vector3, out DistanceInfo), this property contains the point on the collider closest to the location used for calculation.

    See Also

    GetDistance(Vector3)
    TryGetClosestCollider(IXRInteractable, Vector3, out DistanceInfo)
    TryGetClosestPointOnCollider(IXRInteractable, Vector3, out DistanceInfo)
    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