Class IUsesPlaneFindingMethods
Namespace: Unity.MARS
Syntax
public static class IUsesPlaneFindingMethodsMethods
GetPlanes(IUsesPlaneFinding, List<MRPlane>)
Get the currently tracked planes
Declaration
public static void GetPlanes(this IUsesPlaneFinding obj, List<MRPlane> planes)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| List<MRPlane> | planes | A list of MRPlane objects to which the currently tracked planes will be added |
StartDetectingPlanes(IUsesPlaneFinding)
Start detecting planes. Plane detection is enabled on initialization, so this is only necessary after calling StopDetecting.
Declaration
public static void StartDetectingPlanes(this IUsesPlaneFinding obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj |
StopDetectingPlanes(IUsesPlaneFinding)
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 static void StopDetectingPlanes(this IUsesPlaneFinding obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj |
SubscribePlaneAdded(IUsesPlaneFinding, Action<MRPlane>)
Subscribe to the planeAdded event, which is called when a plane becomes tracked for the first time
Declaration
public static void SubscribePlaneAdded(this IUsesPlaneFinding obj, Action<MRPlane> planeAdded)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| Action<MRPlane> | planeAdded | The delegate to subscribe |
SubscribePlaneRemoved(IUsesPlaneFinding, Action<MRPlane>)
Subscribe to the planeRemoved event, which is called when a tracked plane is removed (lost)
Declaration
public static void SubscribePlaneRemoved(this IUsesPlaneFinding obj, Action<MRPlane> planeRemoved)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| Action<MRPlane> | planeRemoved | The delegate to subscribe |
SubscribePlaneUpdated(IUsesPlaneFinding, Action<MRPlane>)
Subscribe to the planeUpdated event, which is called when a tracked plane has new data
Declaration
public static void SubscribePlaneUpdated(this IUsesPlaneFinding obj, Action<MRPlane> planeUpdated)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| Action<MRPlane> | planeUpdated | The delegate to subscribe |
UnsubscribePlaneAdded(IUsesPlaneFinding, Action<MRPlane>)
Unsubscribe from the planeAdded event, which is called when a plane becomes tracked for the first time
Declaration
public static void UnsubscribePlaneAdded(this IUsesPlaneFinding obj, Action<MRPlane> planeAdded)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| Action<MRPlane> | planeAdded | The delegate to unsubscribe |
UnsubscribePlaneRemoved(IUsesPlaneFinding, Action<MRPlane>)
Unsubscribe from the planeRemoved event, which is called when a tracked plane is removed (lost)
Declaration
public static void UnsubscribePlaneRemoved(this IUsesPlaneFinding obj, Action<MRPlane> planeRemoved)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| Action<MRPlane> | planeRemoved | The delegate to unsubscribe |
UnsubscribePlaneUpdated(IUsesPlaneFinding, Action<MRPlane>)
Unsubscribe from the planeUpdated event, which is called when a tracked plane has new data
Declaration
public static void UnsubscribePlaneUpdated(this IUsesPlaneFinding obj, Action<MRPlane> planeUpdated)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesPlaneFinding | obj | |
| Action<MRPlane> | planeUpdated | The delegate to unsubscribe |