Class RecordedPlanesProvider
Inheritance
Implements
Inherited Members
Namespace: Unity.MARS.Recording.Providers
Assembly: Unity.MARS.dll
Syntax
[ProviderSelectionOptions(-1073741825, null, true)]
public class RecordedPlanesProvider : RecordedTrackablesProvider, IRecordedDataProvider, IProvidesPlaneFinding, IFunctionalityProvider, IUsesMARSTrackableData<MRPlane>, IProvidesTraits<Pose>, IProvidesTraits<Vector2>, IProvidesTraits<int>, IProvidesTraits<bool>, IProvidesTraits, INotificationReceiverMethods
ClearData()
Remove all provided data. This is called when a looping recording reaches its duration.
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 |
GetProvidedTraits()
Declaration
public TraitDefinition[] GetProvidedTraits()Returns
| Type | Description |
|---|---|
| TraitDefinition[] |
OnDisable()
Declaration
protected override void OnDisable()Overrides
OnNotify(Playable, INotification, object)
The method called when a notification is raised.
Declaration
public void OnNotify(Playable origin, INotification notification, object context)Parameters
| Type | Name | Description |
|---|---|---|
| Playable | origin | The playable that sent the notification. |
| INotification | notification | The received notification. |
| object | context | User defined data that depends on the type of notification. Uses this to pass necessary information that can change with each invocation. |
StartDetectingPlanes()
Start detecting planes. Plane detection is enabled on initialization, so this is only necessary after calling StopDetecting.
Declaration
public 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
public void StopDetectingPlanes()Events
planeAdded
Called when a plane become tracked for the first time
Declaration
public event Action<MRPlane> planeAddedEvent Type
| Type | Description |
|---|---|
| Action<MRPlane> |
planeRemoved
Called when a tracked plane is removed (Lost)
Declaration
public event Action<MRPlane> planeRemovedEvent Type
| Type | Description |
|---|---|
| Action<MRPlane> |
planeUpdated
Called when a tracked plane has updated data
Declaration
public event Action<MRPlane> planeUpdatedEvent Type
| Type | Description |
|---|---|
| Action<MRPlane> |