Struct XRReferenceObject

Represents a 3D scan of a real object that can be recognized in the environment.

Namespace: UnityEngine.XR.ARSubsystems
Syntax
[Serializable]
public struct XRReferenceObject : IEquatable<XRReferenceObject>
Remarks

Reference objects contain a list of provider-specific "entries". Each "entry" must have previously been generated in a format specific to its implementation of the XRObjectTrackingSubsystem.

Properties

guid

A Guid unique to this reference object.

Declaration
public Guid guid { get; }
Property Value
Type Description
Guid

name

A string name for this reference object.

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

Methods

Equals(Object)

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

Equals(XRReferenceObject)

Declaration
public bool Equals(XRReferenceObject other)
Parameters
Type Name Description
XRReferenceObject other
Returns
Type Description
Boolean

FindEntry(Type)

Finds an XRReferenceObjectEntry by type.

Declaration
public XRReferenceObjectEntry FindEntry(Type type)
Parameters
Type Name Description
Type type

The specific type of XRReferenceObjectEntry to find.
Returns
Type Description
XRReferenceObjectEntry

The provider-specific XRReferenceObjectEntry if found, otherwise null.
Exceptions
Type Condition
ArgumentNullException

Thrown if type is null.
See Also

FindEntry<T>()

Finds an XRReferenceObjectEntry by type.

Declaration
public T FindEntry<T>()
    where T : XRReferenceObjectEntry
Returns
Type Description
T

The provider-specific XRReferenceObjectEntry if found, otherwise null.
Type Parameters
Name Description
T

The specific type of XRReferenceObjectEntry to find.
See Also

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Operators

Equality(XRReferenceObject, XRReferenceObject)

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

Inequality(XRReferenceObject, XRReferenceObject)

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

See Also