Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

XRPlaneSubsystem

class in UnityEngine.Experimental.XR

/

Inherits from:Experimental.Subsystem

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

Description

Provides methods, events, and properties that provides information about planes detected in the environment.

Properties

LastUpdatedFrameThe frame during which the planes were last updated.

Public Methods

GetAllPlanesGet all the BoundedPlanes currently tracked by the system.
TryGetPlaneGet a BoundedPlane by TrackableId
TryGetPlaneBoundaryTry to retrieve a list of positions in device space describing the current plane boundary.

Events

PlaneAddedRaised for each BoundedPlane that has been added in the current frame.
PlaneRemovedRaised for each BoundedPlane that has been removed in the current frame.
PlaneUpdatedRaised for each plane that has been updated in the current frame.

Inherited Members

Public Methods

DestroyDestroys this instance of a subsystem.
StartStarts an instance of a subsystem.
StopStops an instance of a subsystem.

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information