docs.unity3d.com
    Show / Hide Table of Contents

    Struct ARWorldMapRequest

    Represents an asynchronous world map request. Use this to determine the status of the request and get the ARWorldMap once the request is complete.

    Inherited Members
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: UnityEngine.XR.ARKit
    Syntax
    public struct ARWorldMapRequest : IDisposable, IEquatable<ARWorldMapRequest>

    Properties

    status

    Get the status of the request.

    Declaration
    public readonly ARWorldMapRequestStatus status { get; }
    Property Value
    Type Description
    ARWorldMapRequestStatus

    Methods

    Dispose()

    Dispose of the request. You must dispose of the request to avoid leaking resources.

    Declaration
    public void Dispose()
    Implements
    IDisposable.Dispose()

    Equals(Object)

    Tests for equality.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj

    The object to compare against.

    Returns
    Type Description
    Boolean

    True if obj is of type ARWorldMapRequest and Equals(ARWorldMapRequest) also returns true; otherwise false.

    Overrides
    ValueType.Equals(Object)

    Equals(ARWorldMapRequest)

    Tests for equality.

    Declaration
    public bool Equals(ARWorldMapRequest other)
    Parameters
    Type Name Description
    ARWorldMapRequest other

    The other ARWorldMapRequest to compare against.

    Returns
    Type Description
    Boolean

    True if every field in other is equal to this ARWorldMapRequest, otherwise false.

    Implements
    IEquatable<T>.Equals(T)

    GetHashCode()

    Generates a hash suitable for use with containers like HashSet and Dictionary.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    A hash code generated from this object's fields.

    Overrides
    ValueType.GetHashCode()

    GetWorldMap()

    Retrieve the ARWorldMap. It is an error to call this method when status is not Success.

    Declaration
    public ARWorldMap GetWorldMap()
    Returns
    Type Description
    ARWorldMap

    An ARWorldMap representing the state of the session at the time the request was made.

    Operators

    Equality(ARWorldMapRequest, ARWorldMapRequest)

    Tests for equality. Same as Equals(ARWorldMapRequest).

    Declaration
    public static bool operator ==(ARWorldMapRequest lhs, ARWorldMapRequest rhs)
    Parameters
    Type Name Description
    ARWorldMapRequest lhs

    The left-hand side of the comparison.

    ARWorldMapRequest rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(ARWorldMapRequest, ARWorldMapRequest)

    Tests for inequality. Same as !Equals(ARWorldMapRequest).

    Declaration
    public static bool operator !=(ARWorldMapRequest lhs, ARWorldMapRequest rhs)
    Parameters
    Type Name Description
    ARWorldMapRequest lhs

    The left-hand side of the comparison.

    ARWorldMapRequest rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is not equal to rhs, otherwise false.

    Back to top
    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