Struct ARWorldMap
The space-mapping state and set of planes and reference points from
an AR session. This is a wrapper for
ARKit's ARWorldMap
Note: The ARWorldMap must be explicitly disposed to avoid leaking native resources.
Inherited Members
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
Syntax
public struct ARWorldMap : IDisposable, IEquatable<ARWorldMap>
Properties
valid
Use this to determine whether this ARWorldMap is valid, or
if it has been disposed.
Declaration
public bool valid { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Methods
Dispose()
Dispose of the world map. This will invalidate any NativeArrays
previously returned by .
Declaration
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(ARWorldMap)
Declaration
public bool Equals(ARWorldMap other)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
GetHashCode()
Declaration
public override int GetHashCode()
Returns
| Type |
Description |
| System.Int32 |
|
Overrides
System.ValueType.GetHashCode()
Serialize(Allocator)
Serialize the ARWorldMap to an array of bytes. This array may be saved to disk
and loaded at another time to persist the session, or sent over a network
to another ARKit-enabled app to share the session.
It is an error to call this method after the ARWorldMap has been disposed.
Declaration
public NativeArray<byte> Serialize(Allocator allocator)
Parameters
| Type |
Name |
Description |
| Allocator |
allocator |
|
Returns
| Type |
Description |
| NativeArray<System.Byte> |
An array of bytes representing the serialized ARWorldMap.
|
TryDeserialize(NativeArray<Byte>, out ARWorldMap)
Create a new ARWorldMap from a NativeArray of bytes produced
from Serialize(Allocator). Use this to create an ARWorldMap from
a serialized array of bytes, either loaded from disk or sent from another device.
Declaration
public static bool TryDeserialize(NativeArray<byte> serializedWorldMap, out ARWorldMap worldMap)
Parameters
| Type |
Name |
Description |
| NativeArray<System.Byte> |
serializedWorldMap |
An array of bytes representing a serialized ARWorldMap,
produced by Serialize(Allocator).
|
| ARWorldMap |
worldMap |
|
Returns
| Type |
Description |
| System.Boolean |
|
Operators
Equality(ARWorldMap, ARWorldMap)
Declaration
public static bool operator ==(ARWorldMap lhs, ARWorldMap rhs)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Inequality(ARWorldMap, ARWorldMap)
Declaration
public static bool operator !=(ARWorldMap lhs, ARWorldMap rhs)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|