Interface IProvidesPlaneFinding

Defines the API for a Plane Finding Provider This functionality provider is responsible for plane finding

Inherited Members
Namespace: Unity.MARS
Syntax
public interface IProvidesPlaneFinding : IFunctionalityProvider

Methods

GetPlanes(List<MRPlane>)

Get the currently tracked planes

Declaration
void GetPlanes(List<MRPlane> planes)
Parameters
Type Name Description
List<MRPlane> planes

A list of MRPlane objects to which the currently tracked planes will be added

StartDetectingPlanes()

Start detecting planes. Plane detection is enabled on initialization, so this is only necessary after calling StopDetecting.

Declaration
void StartDetectingPlanes()

StopDetectingPlanes()

Stop detecting planes. This will happen automatically on destroying the session. It is only necessary to call this method to pause plane detection while maintaining camera tracking

Declaration
void StopDetectingPlanes()

Events

planeAdded

Called when a plane become tracked for the first time

Declaration
event Action<MRPlane> planeAdded
Event Type
Type Description
Action<MRPlane>

planeRemoved

Called when a tracked plane is removed (Lost)

Declaration
event Action<MRPlane> planeRemoved
Event Type
Type Description
Action<MRPlane>

planeUpdated

Called when a tracked plane has updated data

Declaration
event Action<MRPlane> planeUpdated
Event Type
Type Description
Action<MRPlane>