Class ARReferencePointManager

Inheritance
Object
SubsystemLifecycleManager<XRReferencePointSubsystem, XRReferencePointSubsystemDescriptor>
ARTrackableManager<XRReferencePointSubsystem, XRReferencePointSubsystemDescriptor, XRReferencePoint, ARReferencePoint>
ARReferencePointManager
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Syntax
public sealed class ARReferencePointManager : ARTrackableManager<XRReferencePointSubsystem, XRReferencePointSubsystemDescriptor, XRReferencePoint, ARReferencePoint>

Properties

gameObjectName

Declaration
protected override string gameObjectName { get; }
Property Value
Type Description
String
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRReferencePointSubsystem, XRReferencePointSubsystemDescriptor, XRReferencePoint, UnityEngine.XR.ARFoundation.ARReferencePoint>.gameObjectName

referencePointPrefab

Getter/setter for the Reference Point Prefab.

Declaration
public GameObject referencePointPrefab { get; set; }
Property Value
Type Description
GameObject

Methods

AddReferencePoint(Pose)

Attempts to add an ARReferencePoint with the given Pose.

Declaration
public ARReferencePoint AddReferencePoint(Pose pose)
Parameters
Type Name Description
Pose pose

The pose, in Unity world space, of the ARReferencePoint.
Returns
Type Description
ARReferencePoint

A new ARReferencePoint if successful, otherwise null.
Remarks

If is not null, a new instance of that prefab will be instantiated. Otherwise, a new GameObject will be created. In either case, the resulting GameObject will have an ARReferencePoint component on it.

AttachReferencePoint(ARPlane, Pose)

Attempts to create a new reference point that is attached to an existing ARPlane.

Declaration
public ARReferencePoint AttachReferencePoint(ARPlane plane, Pose pose)
Parameters
Type Name Description
ARPlane plane

The ARPlane to which to attach.
Pose pose

The initial Pose, in Unity world space, of the reference point.
Returns
Type Description
ARReferencePoint

A new ARReferencePoint if successful, otherwise null.

GetPrefab()

Declaration
protected override GameObject GetPrefab()
Returns
Type Description
GameObject
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRReferencePointSubsystem, XRReferencePointSubsystemDescriptor, XRReferencePoint, UnityEngine.XR.ARFoundation.ARReferencePoint>.GetPrefab()

GetReferencePoint(TrackableId)

Gets the ARReferencePoint with given trackableId, or null if it does not exist.

Declaration
public ARReferencePoint GetReferencePoint(TrackableId trackableId)
Parameters
Type Name Description
TrackableId trackableId

The of the ARReferencePoint to retrieve.
Returns
Type Description
ARReferencePoint

The ARReferencePoint with trackableId or null if it does not exist.

OnTrackablesChanged(List<ARReferencePoint>, List<ARReferencePoint>, List<ARReferencePoint>)

Declaration
protected override void OnTrackablesChanged(List<ARReferencePoint> addedPoints, List<ARReferencePoint> updatedPoints, List<ARReferencePoint> removedPoints)
Parameters
Type Name Description
List<ARReferencePoint> addedPoints
List<ARReferencePoint> updatedPoints
List<ARReferencePoint> removedPoints
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRReferencePointSubsystem, XRReferencePointSubsystemDescriptor, XRReferencePoint, UnityEngine.XR.ARFoundation.ARReferencePoint>.OnTrackablesChanged(System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARReferencePoint>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARReferencePoint>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARReferencePoint>)

RemoveReferencePoint(ARReferencePoint)

Attempts to remove an ARReferencePoint.

Declaration
public bool RemoveReferencePoint(ARReferencePoint referencePoint)
Parameters
Type Name Description
ARReferencePoint referencePoint

The reference point you wish to remove.
Returns
Type Description
Boolean

True if the reference point was successfully removed. False usually means the reference point is not longer tracked by the system.

Events

referencePointsChanged

Invoked once per frame to communicate changes to reference points, including new reference points, the update of existing reference points, and the removal of previously existing reference points.

Declaration
public event Action<ARReferencePointsChangedEventArgs> referencePointsChanged
Event Type
Type Description
Action<ARReferencePointsChangedEventArgs>