docs.unity3d.com
    Show / Hide Table of Contents

    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
    Inherited Members
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    [CreateAssetMenu(fileName = "ReferenceObjectLibrary", menuName = "XR/Reference Object Library", order = 3)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arsubsystems@4.0/manual/object-tracking.html")]
    public class XRReferenceObjectLibrary : ScriptableObject

    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

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

    An IEnumerator which can be used to iterate over the reference objects in the 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
    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.

    Extension Methods

    XRReferenceObjectLibraryExtensions.Add(XRReferenceObjectLibrary)
    XRReferenceObjectLibraryExtensions.RemoveAt(XRReferenceObjectLibrary, Int32)
    XRReferenceObjectLibraryExtensions.SetReferenceObjectName(XRReferenceObjectLibrary, Int32, String)
    XRReferenceObjectLibraryExtensions.SetReferenceObjectEntry(XRReferenceObjectLibrary, Int32, Type, XRReferenceObjectEntry)

    See Also

    XRReferenceObject
    XRReferenceObjectEntry
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023