docs.unity3d.com
    Show / Hide Table of Contents

    Class XRReferencePointSubsystem

    Base class for a reference point subsystem.

    Inheritance
    Object
    Subsystem
    Subsystem<XRReferencePointSubsystemDescriptor>
    XRSubsystem<XRReferencePointSubsystemDescriptor>
    TrackingSubsystem<XRReferencePoint, XRReferencePointSubsystemDescriptor>
    XRReferencePointSubsystem
    Inherited Members
    TrackingSubsystem<XRReferencePoint, XRReferencePointSubsystemDescriptor>.GetChanges(Allocator)
    XRSubsystem<XRReferencePointSubsystemDescriptor>.running
    XRSubsystem<XRReferencePointSubsystemDescriptor>.OnDestroy()
    XRSubsystem<XRReferencePointSubsystemDescriptor>.Start()
    XRSubsystem<XRReferencePointSubsystemDescriptor>.Stop()
    Subsystem<XRReferencePointSubsystemDescriptor>.SubsystemDescriptor
    Subsystem.Destroy()
    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    [Obsolete("XRReferencePointSubsystem has been deprecated. Use XRAnchorSubsystem instead (UnityUpgradable) -> UnityEngine.XR.ARSubsystems.XRAnchorSubsystem", false)]
    public abstract class XRReferencePointSubsystem : TrackingSubsystem<XRReferencePoint, XRReferencePointSubsystemDescriptor>, ISubsystem
    Remarks

    A reference point is a pose in the physical environment that is tracked by an XR device. As the device refines its understanding of the environment, reference points will be updated, allowing developers to keep virtual content connected to a real-world position and orientation.

    This abstract class should be implemented by an XR provider and instantiated using the SubsystemManager to enumerate the available XRReferencePointSubsystemDescriptors.

    Constructors

    XRReferencePointSubsystem()

    Constructor. Do not invoke directly; use the SubsystemManager to enumerate the available XRReferencePointSubsystemDescriptors and call Create on the desired descriptor.

    Declaration
    public XRReferencePointSubsystem()

    Methods

    CreateProvider()

    Should create an instance of XRReferencePointSubsystem.Provider.

    Declaration
    protected abstract XRReferencePointSubsystem.Provider CreateProvider()
    Returns
    Type Description
    XRReferencePointSubsystem.Provider

    The interface to the implementation-specific provider.

    GetChanges(Allocator)

    Get the changes (added, updated, and removed) reference points since the last call to GetChanges(Allocator).

    Declaration
    public override TrackableChanges<XRReferencePoint> GetChanges(Allocator allocator)
    Parameters
    Type Name Description
    Allocator allocator

    An allocator to use for the NativeArrays in TrackableChanges<T>.

    Returns
    Type Description
    TrackableChanges<XRReferencePoint>

    Changes since the last call to GetChanges(Allocator).

    Overrides
    UnityEngine.XR.ARSubsystems.TrackingSubsystem<UnityEngine.XR.ARSubsystems.XRReferencePoint, UnityEngine.XR.ARSubsystems.XRReferencePointSubsystemDescriptor>.GetChanges(Unity.Collections.Allocator)

    OnDestroyed()

    Destroys the subsystem.

    Declaration
    protected sealed override void OnDestroyed()
    Overrides
    UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRReferencePointSubsystemDescriptor>.OnDestroyed()

    OnStart()

    Starts the subsystem.

    Declaration
    protected sealed override void OnStart()
    Overrides
    UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRReferencePointSubsystemDescriptor>.OnStart()

    OnStop()

    Stops the subsystem.

    Declaration
    protected sealed override void OnStop()
    Overrides
    UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRReferencePointSubsystemDescriptor>.OnStop()

    TryAddReferencePoint(Pose, out XRReferencePoint)

    Attempts to create a new reference point with the provide pose.

    Declaration
    [Obsolete("XRReferencePointSubsystem.TryAddReferencePoint() has been deprecated. Use XRAnchorSubsystem.TryAddAnchor() instead (UnityUpgradable) -> UnityEngine.XR.ARSubsystems.XRAnchorSubsystem.TryAddAnchor(Pose, XRAnchor)", true)]
    public bool TryAddReferencePoint(Pose pose, out XRReferencePoint referencePoint)
    Parameters
    Type Name Description
    Pose pose

    The pose, in session space, of the new reference point.

    XRReferencePoint referencePoint

    The new reference point. Only valid if this method returns true.

    Returns
    Type Description
    Boolean

    true if the new reference point was added, otherwise false.

    TryAttachReferencePoint(TrackableId, Pose, out XRReferencePoint)

    Attempts to create a new reference "attached" to the trackable with id trackableToAffix. The behavior of the reference point depends on the type of trackable to which this reference point is attached.

    Declaration
    [Obsolete("XRReferencePointSubsystem.TryAttachReferencePoint() has been deprecated. Use XRAnchorSubsystem.TryAttachAnchor() instead (UnityUpgradable) -> UnityEngine.XR.ARSubsystems.XRAnchorSubsystem.TryAttachAnchor(TrackableId, Pose, XRAnchor)", true)]
    public bool TryAttachReferencePoint(TrackableId trackableToAffix, Pose pose, out XRReferencePoint referencePoint)
    Parameters
    Type Name Description
    TrackableId trackableToAffix

    The id of the trackable to which to attach.

    Pose pose

    The pose, in session space, of the reference point to create.

    XRReferencePoint referencePoint

    The new reference point. Only valid if this method returns true.

    Returns
    Type Description
    Boolean

    true if the new reference point was added, otherwise false.

    TryRemoveReferencePoint(TrackableId)

    Attempts to remove an existing reference point with TrackableId referencePointId.

    Declaration
    [Obsolete("XRReferencePointSubsystem.TryRemoveReferencePoint() has been deprecated. Use XRAnchorSubsystem.TryRemoveAnchor() instead (UnityUpgradable) -> UnityEngine.XR.ARSubsystems.XRAnchorSubsystem.TryRemoveAnchor(*)", true)]
    public bool TryRemoveReferencePoint(TrackableId referencePointId)
    Parameters
    Type Name Description
    TrackableId referencePointId

    The id of an existing reference point to remove.

    Returns
    Type Description
    Boolean

    true if the reference point was removed, otherwise false.

    Back to top
    Terms of use
    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