Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

XRPlaneSubsystem.TryGetPlaneBoundary

Other Versions
Leave feedback
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

public bool TryGetPlaneBoundary(Experimental.XR.TrackableId planeId, List<Vector3> boundaryOut);

Parameters

planeIdThe session-unique TrackableId of the plane.
boundaryOutA list of vertices representing the plane's boundary.

Returns

bool True if the plane exists (i.e., is still being tracked), otherwise false.

Description

Try to retrieve a list of positions in device space describing the current plane boundary.

If successful, the boundaryOut parameter is populated with vertices describing the plane's boundary. The boundary will always contain at least four vertices, and may contain more depending on the specific device providing the boundary. Returns false if the plane is no longer tracked by the system.

See Also: BoundedPlane.TryGetBoundary

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2018.3-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information