Class MagicLeapPlaneSubsystem.PlaneProvider

Inheritance
object
SubsystemProvider
SubsystemProvider<XRPlaneSubsystem>
XRPlaneSubsystem.Provider
MagicLeapPlaneSubsystem.PlaneProvider
Inherited Members
XRPlaneSubsystem.Provider.CreateOrResizeNativeArrayIfNecessary<T>(int, Allocator, ref NativeArray<T>)
SubsystemProvider<XRPlaneSubsystem>.TryInitialize()
SubsystemProvider.running
object.Equals(object)
object.Equals(object, object)
Namespace: UnityEngine.XR.MagicLeap
Assembly: UnityEngine.XR.MagicLeap.dll
Syntax
public class MagicLeapPlaneSubsystem.PlaneProvider : XRPlaneSubsystem.Provider

Constructors

PlaneProvider()

Declaration
public PlaneProvider()

Properties

currentPlaneDetectionMode

Get the current plane detection mode in use by the provider.

Declaration
public override PlaneDetectionMode currentPlaneDetectionMode { get; }
Property Value
Type Description
PlaneDetectionMode
Overrides
UnityEngine.XR.ARSubsystems.XRPlaneSubsystem.Provider.currentPlaneDetectionMode

requestedPlaneDetectionMode

Get or set the requested UnityEngine.XR.ARSubsystems.PlaneDetectionMode.

Declaration
public override PlaneDetectionMode requestedPlaneDetectionMode { get; set; }
Property Value
Type Description
PlaneDetectionMode
Overrides
UnityEngine.XR.ARSubsystems.XRPlaneSubsystem.Provider.requestedPlaneDetectionMode

Methods

Destroy()

Declaration
public override void Destroy()
Overrides
UnityEngine.SubsystemsImplementation.SubsystemProvider<UnityEngine.XR.ARSubsystems.XRPlaneSubsystem>.Destroy()

GetAllBoundariesForPlane(TrackableId)

Declaration
public PlaneBoundaryCollection GetAllBoundariesForPlane(TrackableId trackableId)
Parameters
Type Name Description
TrackableId trackableId
Returns
Type Description
PlaneBoundaryCollection

GetBoundary(TrackableId, Allocator, ref NativeArray<Vector2>)

Gets the boundary vertices of a given UnityEngine.XR.ARSubsystems.BoundedPlane based on its UnityEngine.XR.ARSubsystems.BoundedPlane.trackableId.

Declaration
public override void GetBoundary(TrackableId trackableId, Allocator allocator, ref NativeArray<Vector2> convexHullOut)
Parameters
Type Name Description
TrackableId trackableId

The UnityEngine.XR.ARSubsystems.TrackableId of a UnityEngine.XR.ARSubsystems.BoundedPlane.
Allocator allocator

An Allocator to use if boundary needs to be created. Temp is not supported. Use TempJob if you need temporary memory.
NativeArray<Vector2> convexHullOut
Overrides
Remarks

See CreateOrResizeNativeArrayIfNecessary<T>(int, Allocator, ref NativeArray<T>) for a helper method implementation.

GetChanges(BoundedPlane, Allocator)

Gets a UnityEngine.XR.ARSubsystems.TrackableChanges<T> struct containing any changes to detected planes since the last time you called this method. You are responsible to UnityEngine.XR.ARSubsystems.TrackableChanges<T>.Dispose() the returned TrackableChanges instance.

Declaration
public override TrackableChanges<BoundedPlane> GetChanges(BoundedPlane defaultPlane, Allocator allocator)
Parameters
Type Name Description
BoundedPlane defaultPlane

The default plane. You should use this to initialize the returned UnityEngine.XR.ARSubsystems.TrackableChanges<T> instance by passing it to the constructor TrackableChanges(int, int, int, Allocator, T).
Allocator allocator

An Allocator to use when allocating the returned NativeArrays.
Returns
Type Description
TrackableChanges<BoundedPlane>

The changes to planes since the last call to this method.
Overrides

Start()

Declaration
public override void Start()
Overrides
UnityEngine.SubsystemsImplementation.SubsystemProvider<UnityEngine.XR.ARSubsystems.XRPlaneSubsystem>.Start()

Stop()

Declaration
public override void Stop()
Overrides
UnityEngine.SubsystemsImplementation.SubsystemProvider<UnityEngine.XR.ARSubsystems.XRPlaneSubsystem>.Stop()

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