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.

Implements
Inherited Members
Namespace: UnityEngine.XR.ARKit
Assembly: Unity.XR.ARKit.dll
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)

Tests for equality.

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

The object to compare against.
Returns
Type Description
bool

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

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
bool

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

GetHashCode()

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

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code generated from this object's fields.
Overrides

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

operator ==(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
bool

True if lhs is equal to rhs, otherwise false.

operator !=(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
bool

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

Implements