Struct ARWorldMapRequest | Package Manager UI website
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.

    Namespace: UnityEngine.XR.ARKit
    Syntax
    public struct ARWorldMapRequest : IDisposable, IEquatable<ARWorldMapRequest>

    Properties

    status

    Get the status of the request.

    Declaration
    public 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()

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    Equals(ARWorldMapRequest)

    Declaration
    public bool Equals(ARWorldMapRequest other)
    Parameters
    Type Name Description
    ARWorldMapRequest other
    Returns
    Type Description
    System.Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.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)

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

    Inequality(ARWorldMapRequest, ARWorldMapRequest)

    Declaration
    public static bool operator !=(ARWorldMapRequest lhs, ARWorldMapRequest rhs)
    Parameters
    Type Name Description
    ARWorldMapRequest lhs
    ARWorldMapRequest rhs
    Returns
    Type Description
    System.Boolean
    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