Class RecordedPlanesProvider

Inheritance
Object
RecordedTrackablesProvider
RecordedPlanesProvider
Inherited Members
Namespace: Unity.MARS.Recording.Providers
Syntax
public class RecordedPlanesProvider : RecordedTrackablesProvider, IRecordedDataProvider, IProvidesPlaneFinding, IFunctionalityProvider, IUsesMARSTrackableData<MRPlane>, IProvidesTraits<Pose>, IProvidesTraits<Vector2>, IProvidesTraits<int>, IProvidesTraits<bool>, IProvidesTraits, INotificationReceiver

Methods

ClearData()

Declaration
public override void ClearData()
Overrides

GetPlanes(List<MRPlane>)

Get the currently tracked planes

Declaration
public 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
Implements

GetProvidedTraits()

Declaration
public TraitDefinition[] GetProvidedTraits()
Returns
Type Description
TraitDefinition[]
Implements

OnDisable()

Declaration
protected override void OnDisable()
Overrides

OnNotify(Playable, INotification, Object)

Declaration
public void OnNotify(Playable origin, INotification notification, object context)
Parameters
Type Name Description
Playable origin
INotification notification
Object context

StartDetectingPlanes()

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

Declaration
public void StartDetectingPlanes()
Implements

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
public void StopDetectingPlanes()
Implements

Events

planeAdded

Called when a plane become tracked for the first time

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

planeRemoved

Called when a tracked plane is removed (Lost)

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

planeUpdated

Called when a tracked plane has updated data

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