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
Object
ScriptableObject
XRReferenceObjectLibrary
Implements
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.ToString()
Object.name
Object.hideFlags
Namespace: UnityEngine.XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
[CreateAssetMenu(fileName = "ReferenceObjectLibrary", menuName = "XR/Reference Object Library", order = 3)]
public class XRReferenceObjectLibrary : ScriptableObject, IEnumerable<XRReferenceObject>, IEnumerable

Properties

this[int]

Get a reference object by index.

Declaration
public XRReferenceObject this[int index] { get; }
Parameters
Type Name Description
int 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.
See Also

count

The number of reference objects in the library.

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

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
See Also

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.
See Also

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<XRReferenceObject>.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);
}
See Also

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
int

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

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
int

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

Implements

See Also