Class XRReferenceObjectLibrary

A container for reference objects. A reference object represents a 3D scan of a real object that can be recognized in the environment. A XRObjectTrackingSubsystem will search for objects based on the contents of a XRReferenceObjectLibrary.

Inheritance
Object
UnityEngine.Object
UnityEngine.ScriptableObject
XRReferenceObjectLibrary
Inherited Members
UnityEngine.ScriptableObject.SetDirty()
UnityEngine.ScriptableObject.CreateInstance(System.String)
UnityEngine.ScriptableObject.CreateInstance(System.Type)
UnityEngine.ScriptableObject.CreateInstance<T>()
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
Namespace: UnityEngine.XR.ARSubsystems
Syntax
[CreateAssetMenu(fileName = "ReferenceObjectLibrary", menuName = "XR/Reference Object Library", order = 3)]
public class XRReferenceObjectLibrary : ScriptableObject, IEnumerable<XRReferenceObject>, IEnumerable

Properties

count

The number of reference objects in the library.

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

guid

A GUID associated with this reference library. The GUID is used to uniquely identify this library at runtime.

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

Item[Int32]

Get a reference object by index.

Declaration
public XRReferenceObject this[int index] { get; }
Parameters
Type Name Description
Int32 index

The index in the array of reference objects. Must be greater than or equal to 0 and less than count.
Property Value
Type Description
XRReferenceObject

The XRReferenceObject at index.

Methods

Add(XRReferenceObject)

Adds a new XRReferenceObject to this library.

Declaration
public void Add(XRReferenceObject referenceObject)
Parameters
Type Name Description
XRReferenceObject referenceObject

The reference object to add.

GetEnumerator()

Gets an enumerator which can be used to iterate over the reference objects in this library.

Declaration
public List<XRReferenceObject>.Enumerator GetEnumerator()
Returns
Type Description
List.Enumerator<>

Returns an enumerator which can be used to iterate over the reference objects in this library.
Examples

This examples iterates over the reference objects contained in the library.

XRReferenceObjectLibrary library = ...
foreach (var referenceObject in library)
{
    Debug.LogFormat("Reference object guid: {0}", referenceObject.guid);
}

indexOf(XRReferenceObject)

Get the index of referenceObject in the object library.

Declaration
[Obsolete("Use IndexOf instead (deprecated 2021-02-01).")]
public int indexOf(XRReferenceObject referenceObject)
Parameters
Type Name Description
XRReferenceObject referenceObject

The XRReferenceObject to find.
Returns
Type Description
Int32

The zero-based index of the referenceObject, or -1 if not found.

IndexOf(XRReferenceObject)

Get the index of referenceObject in the object library.

Declaration
public int IndexOf(XRReferenceObject referenceObject)
Parameters
Type Name Description
XRReferenceObject referenceObject

The XRReferenceObject to find.
Returns
Type Description
Int32

Returns the zero-based index of the referenceObject if found. Returns -1 if not found.

Explicit Interface Implementations

IEnumerable<XRReferenceObject>.GetEnumerator()

Gets an enumerator which can be used to iterate over the reference objects in this library.

Declaration
IEnumerator<XRReferenceObject> IEnumerable<XRReferenceObject>.GetEnumerator()
Returns
Type Description
IEnumerator<XRReferenceObject>

Returns an object which can be used to iterate over the reference objects in this library.
Implements

IEnumerable.GetEnumerator()

Gets an enumerator which can be used to iterate over the reference objects in this library.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
IEnumerator

Returns an object which can be used to iterate over the reference objects in this library.
Implements

Extension Methods

See Also