Version: 2018.4
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

XRReferencePointSubsystem.TryAddReferencePoint

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool TryAddReferencePoint(Vector3 position, Quaternion rotation, out Experimental.XR.TrackableId referencePointId);

Parameters

position Current position, in device space, of a point you want the device to track.
rotation Current rotation, in device space, of a point you want the device to track.
referencePointId If this method returns true, this is filled out with the ID (unique to the session) of the point.

Returns

bool If the ReferencePoint was added successfully, this method returns true. Otherwise, it returns false.

Description

Attempt to add a ReferencePoint that gets tracked by the device.


Declaration

public bool TryAddReferencePoint(Pose pose, out Experimental.XR.TrackableId referencePointId);

Parameters

pose Current pose, in device space, of a point you want the device to track.
referencePointId If this method returns true, this is filled out with the ID (unique to the session) of the point.

Returns

bool If the ReferencePoint was added successfully, this method returns true. Otherwise, it returns false.

Description

Attempt to add a ReferencePoint that gets tracked by the device.