Struct ARObjectInfo

Represents metadata associated with a .arobject archive. These archives are the source data for ARKitReferenceObjectEntry.

Namespace: UnityEditor.XR.ARKit
Syntax
public struct ARObjectInfo : IEquatable<ARObjectInfo>

Constructors

ARObjectInfo(XmlDocument)

Parses the plist and constructs a new ARObjectInfo.

Declaration
public ARObjectInfo(XmlDocument plist)
Parameters
Type Name Description
XmlDocument plist

A valid PlistDocument to parse.
Exceptions
Type Condition
ArgumentNullException

Thrown if plist is null.

Properties

imageReference

The filename of an image contained within the archive that can be used as a preview for the scanned object.

Declaration
public string imageReference { get; }
Property Value
Type Description
String

referenceOrigin

The reference origin for the scanned object.

Declaration
public Pose referenceOrigin { get; }
Property Value
Type Description
Pose

trackingDataReference

The filename of the source data representing the scanned object.

Declaration
public string trackingDataReference { get; }
Property Value
Type Description
String

valid

true if the ARObjectInfo represents valid data, otherwise false.

Declaration
public bool valid { get; }
Property Value
Type Description
Boolean

version

The version of the metadata format.

Declaration
public int version { get; }
Property Value
Type Description
Int32

Methods

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 ARObjectInfo and Equals(ARObjectInfo) also returns true; otherwise false.
Overrides

Equals(ARObjectInfo)

Tests for equality.

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

The other ARObjectInfo to compare against.
Returns
Type Description
Boolean

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

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

Operators

Equality(ARObjectInfo, ARObjectInfo)

Tests for equality. Same as Equals(ARObjectInfo).

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

The left-hand side of the comparison.
ARObjectInfo rhs

The right-hand side of the comparison.
Returns
Type Description
Boolean

True if lhs is equal to rhs, otherwise false.

Inequality(ARObjectInfo, ARObjectInfo)

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

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

The left-hand side of the comparison.
ARObjectInfo rhs

The right-hand side of the comparison.
Returns
Type Description
Boolean

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

See Also