docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SimulatedPlanesProvider

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    SimulatedTrackablesProvider<MRPlane>
    SimulatedPlanesProvider
    Implements
    IUsesFunctionalityInjection
    IFunctionalitySubscriber<IProvidesFunctionalityInjection>
    IUsesSlowTasks
    IFunctionalitySubscriber<IProvidesSlowTasks>
    IFunctionalitySubscriber
    IProvidesPlaneFinding
    IFunctionalityProvider
    IProvidesTraits<Pose>
    IProvidesTraits<Vector2>
    IProvidesTraits<int>
    IProvidesTraits<bool>
    IProvidesTraits
    IUsesMARSTrackableData<MRPlane>
    Inherited Members
    SimulatedTrackablesProvider<MRPlane>.m_SimulatedTrackables
    SimulatedTrackablesProvider<MRPlane>.OnEnable()
    SimulatedTrackablesProvider<MRPlane>.OnDisable()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.MARS.Providers.Synthetic
    Assembly: Unity.MARS.dll
    Syntax
    [AddComponentMenu("")]
    [ProviderSelectionOptions(-1073741824, null, false)]
    [MovedFrom("Unity.MARS.Providers")]
    public class SimulatedPlanesProvider : SimulatedTrackablesProvider<MRPlane>, IUsesFunctionalityInjection, IFunctionalitySubscriber<IProvidesFunctionalityInjection>, IUsesSlowTasks, IFunctionalitySubscriber<IProvidesSlowTasks>, IFunctionalitySubscriber, IProvidesPlaneFinding, IFunctionalityProvider, IProvidesTraits<Pose>, IProvidesTraits<Vector2>, IProvidesTraits<int>, IProvidesTraits<bool>, IProvidesTraits, IUsesMARSTrackableData<MRPlane>

    Methods

    AddObjectTrackables(SimulatedObject)

    Declaration
    protected override void AddObjectTrackables(SimulatedObject simulatedObject)
    Parameters
    Type Name Description
    SimulatedObject simulatedObject
    Overrides
    SimulatedTrackablesProvider<MRPlane>.AddObjectTrackables(SimulatedObject)

    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[]

    RemoveTrackable(MRPlane)

    Declaration
    protected override void RemoveTrackable(MRPlane trackable)
    Parameters
    Type Name Description
    MRPlane trackable
    Overrides
    SimulatedTrackablesProvider<MRPlane>.RemoveTrackable(MRPlane)

    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()

    UpdateObjectTrackables(SimulatedObject)

    Declaration
    protected override void UpdateObjectTrackables(SimulatedObject simulatedObject)
    Parameters
    Type Name Description
    SimulatedObject simulatedObject
    Overrides
    SimulatedTrackablesProvider<MRPlane>.UpdateObjectTrackables(SimulatedObject)

    Events

    planeAdded

    Called when a plane become tracked for the first time

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

    planeRemoved

    Called when a tracked plane is removed (Lost)

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

    planeUpdated

    Called when a tracked plane has updated data

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

    Implements

    Unity.XRTools.ModuleLoader.IUsesFunctionalityInjection
    Unity.XRTools.ModuleLoader.IFunctionalitySubscriber<TProvider>
    IUsesSlowTasks
    Unity.XRTools.ModuleLoader.IFunctionalitySubscriber<TProvider>
    Unity.XRTools.ModuleLoader.IFunctionalitySubscriber
    IProvidesPlaneFinding
    Unity.XRTools.ModuleLoader.IFunctionalityProvider
    IProvidesTraits<T>
    IProvidesTraits<T>
    IProvidesTraits<T>
    IProvidesTraits<T>
    IProvidesTraits
    IUsesMARSTrackableData<T>

    Extension Methods

    IUsesMARSTrackableDataGenericMethods.AddData<T>(IUsesMARSTrackableData<T>, int, T)
    IUsesMARSTrackableDataGenericMethods.AddOrUpdateData<T>(IUsesMARSTrackableData<T>, T)
    IUsesMARSTrackableDataGenericMethods.GetCollection<T>(IUsesMARSTrackableData<T>)
    IUsesMARSTrackableDataGenericMethods.GetIdValue<T>(IUsesMARSTrackableData<T>, int)
    IUsesMARSTrackableDataGenericMethods.RegisterProcessingJob<T>(IUsesMARSTrackableData<T>, ProcessingJobType)
    IUsesMARSTrackableDataGenericMethods.RemoveData<T>(IUsesMARSTrackableData<T>, T)
    IUsesMARSTrackableDataGenericMethods.UnregisterProcessingJob<T>(IUsesMARSTrackableData<T>, ProcessingJobType)
    IUsesSlowTasksMethods.AddMarsTimeSlowTask(IUsesSlowTasks, Action, float, bool)
    IUsesSlowTasksMethods.AddSlowTask(IUsesSlowTasks, Action, float, bool)
    IUsesSlowTasksMethods.RemoveMarsTimeSlowTask(IUsesSlowTasks, Action)
    IUsesSlowTasksMethods.RemoveSlowTask(IUsesSlowTasks, Action)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)