docs.unity3d.com
    Show / Hide Table of Contents

    Class AROcclusionManager

    The manager for the occlusion subsystem.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>
    AROcclusionManager
    Inherited Members
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.subsystem
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.descriptor
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.GetActiveSubsystemInstance()
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.EnsureSubsystemInstanceSet()
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.OnEnable()
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.OnDisable()
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.OnDestroy()
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.OnBeforeStart()
    SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>.OnAfterStart()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    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, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, Boolean)
    Component.GetComponentInParent(Type)
    UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, 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
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    UnityEngine.Object.FindFirstObjectByType<T>()
    UnityEngine.Object.FindAnyObjectByType<T>()
    UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
    UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    [DisallowMultipleComponent]
    [DefaultExecutionOrder(-2147483647)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.2/api/UnityEngine.XR.ARFoundation.AROcclusionManager.html")]
    public sealed class AROcclusionManager : SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>

    Properties

    currentEnvironmentDepthMode

    Get the current environment depth mode in use by the subsystem.

    Declaration
    public EnvironmentDepthMode currentEnvironmentDepthMode { get; }
    Property Value
    Type Description
    EnvironmentDepthMode

    currentHumanDepthMode

    Get the current human segmentation depth mode in use by the subsystem.

    Declaration
    public HumanSegmentationDepthMode currentHumanDepthMode { get; }
    Property Value
    Type Description
    HumanSegmentationDepthMode

    currentHumanStencilMode

    Get the current mode in use for generating the human segmentation stencil mode.

    Declaration
    public HumanSegmentationStencilMode currentHumanStencilMode { get; }
    Property Value
    Type Description
    HumanSegmentationStencilMode

    currentOcclusionPreferenceMode

    Get the current occlusion preference mode in use by the subsystem.

    Declaration
    public OcclusionPreferenceMode currentOcclusionPreferenceMode { get; }
    Property Value
    Type Description
    OcclusionPreferenceMode

    environmentDepthConfidenceTexture

    The environment depth confidence texture.

    Declaration
    public Texture2D environmentDepthConfidenceTexture { get; }
    Property Value
    Type Description
    Texture2D

    The environment depth confidence texture, if any. Otherwise, null.

    environmentDepthTemporalSmoothingEnabled

    Whether temporal smoothing is applied to the environment depth image. Query for support with environmentDepthTemporalSmoothingSupported.

    Declaration
    public bool environmentDepthTemporalSmoothingEnabled { get; }
    Property Value
    Type Description
    Boolean

    Read Only.

    environmentDepthTemporalSmoothingRequested

    Whether temporal smoothing should be applied to the environment depth image. Query for support with environmentDepthTemporalSmoothingSupported.

    Declaration
    public bool environmentDepthTemporalSmoothingRequested { get; set; }
    Property Value
    Type Description
    Boolean

    When true, temporal smoothing is applied to the environment depth image. Otherwise, no temporal smoothing is applied.

    environmentDepthTexture

    The environment depth texture.

    Declaration
    public Texture2D environmentDepthTexture { get; }
    Property Value
    Type Description
    Texture2D

    The environment depth texture, if any. Otherwise, null.

    humanDepthTexture

    The human segmentation depth texture.

    Declaration
    public Texture2D humanDepthTexture { get; }
    Property Value
    Type Description
    Texture2D

    The human segmentation depth texture, if any. Otherwise, null.

    humanSegmentationDepthMode

    The mode for generating the human segmentation depth texture. This method is obsolete. Use requestedHumanDepthMode or currentHumanDepthMode instead.

    Declaration
    [Obsolete("Use requestedSegmentationDepthMode or currentSegmentationDepthMode instead. (2020-01-15)")]
    public HumanSegmentationDepthMode humanSegmentationDepthMode { get; set; }
    Property Value
    Type Description
    HumanSegmentationDepthMode

    humanSegmentationStencilMode

    The mode for generating the human segmentation stencil texture. This method is obsolete. Use requestedHumanStencilMode or currentHumanStencilMode instead.

    Declaration
    [Obsolete("Use requestedSegmentationStencilMode or currentSegmentationStencilMode instead. (2020-01-14)")]
    public HumanSegmentationStencilMode humanSegmentationStencilMode { get; set; }
    Property Value
    Type Description
    HumanSegmentationStencilMode

    humanStencilTexture

    The human segmentation stencil texture.

    Declaration
    public Texture2D humanStencilTexture { get; }
    Property Value
    Type Description
    Texture2D

    The human segmentation stencil texture, if any. Otherwise, null.

    requestedEnvironmentDepthMode

    Get or set the requested environment depth mode.

    Declaration
    public EnvironmentDepthMode requestedEnvironmentDepthMode { get; set; }
    Property Value
    Type Description
    EnvironmentDepthMode

    requestedHumanDepthMode

    Get or set the requested human segmentation depth mode.

    Declaration
    public HumanSegmentationDepthMode requestedHumanDepthMode { get; set; }
    Property Value
    Type Description
    HumanSegmentationDepthMode

    requestedHumanStencilMode

    The requested mode for generating the human segmentation stencil texture.

    Declaration
    public HumanSegmentationStencilMode requestedHumanStencilMode { get; set; }
    Property Value
    Type Description
    HumanSegmentationStencilMode

    requestedOcclusionPreferenceMode

    Get or set the requested occlusion preference mode.

    Declaration
    public OcclusionPreferenceMode requestedOcclusionPreferenceMode { get; set; }
    Property Value
    Type Description
    OcclusionPreferenceMode

    Methods

    OnBeforeStart()

    Callback before the subsystem is started (but after it is created).

    Declaration
    protected override void OnBeforeStart()
    Overrides
    UnityEngine.XR.ARFoundation.SubsystemLifecycleManager<UnityEngine.XR.ARSubsystems.XROcclusionSubsystem, UnityEngine.XR.ARSubsystems.XROcclusionSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XROcclusionSubsystem.Provider>.OnBeforeStart()

    OnDisable()

    Callback when the manager is being disabled.

    Declaration
    protected override void OnDisable()
    Overrides
    UnityEngine.XR.ARFoundation.SubsystemLifecycleManager<UnityEngine.XR.ARSubsystems.XROcclusionSubsystem, UnityEngine.XR.ARSubsystems.XROcclusionSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XROcclusionSubsystem.Provider>.OnDisable()

    TryAcquireEnvironmentDepthConfidenceCpuImage(out XRCpuImage)

    Attempt to get the latest environment depth confidence CPU image. This provides direct access to the raw pixel data.

    Declaration
    public bool TryAcquireEnvironmentDepthConfidenceCpuImage(out XRCpuImage cpuImage)
    Parameters
    Type Name Description
    XRCpuImage cpuImage

    If this method returns true, an acquired XRCpuImage.

    Returns
    Type Description
    Boolean

    Returns true if the CPU image was acquired. Returns false otherwise.

    Remarks

    The XRCpuImage must be disposed to avoid resource leaks.

    TryAcquireEnvironmentDepthCpuImage(out XRCpuImage)

    Attempt to get the latest environment depth CPU image. This provides direct access to the raw pixel data.

    Declaration
    public bool TryAcquireEnvironmentDepthCpuImage(out XRCpuImage cpuImage)
    Parameters
    Type Name Description
    XRCpuImage cpuImage

    If this method returns true, an acquired XRCpuImage.

    Returns
    Type Description
    Boolean

    Returns true if the CPU image was acquired. Returns false otherwise.

    Remarks

    The XRCpuImage must be disposed to avoid resource leaks.

    TryAcquireHumanDepthCpuImage(out XRCpuImage)

    Attempt to get the latest human depth CPU image. This provides direct access to the raw pixel data.

    Declaration
    public bool TryAcquireHumanDepthCpuImage(out XRCpuImage cpuImage)
    Parameters
    Type Name Description
    XRCpuImage cpuImage

    If this method returns true, an acquired XRCpuImage.

    Returns
    Type Description
    Boolean

    Returns true if the CPU image was acquired. Returns false otherwise.

    Remarks

    The XRCpuImage must be disposed to avoid resource leaks.

    TryAcquireHumanStencilCpuImage(out XRCpuImage)

    Attempt to get the latest human stencil CPU image. This provides directly access to the raw pixel data.

    Declaration
    public bool TryAcquireHumanStencilCpuImage(out XRCpuImage cpuImage)
    Parameters
    Type Name Description
    XRCpuImage cpuImage

    If this method returns true, an acquired XRCpuImage.

    Returns
    Type Description
    Boolean

    Returns true if the CPU image was acquired. Returns false otherwise.

    Remarks

    The XRCpuImage must be disposed to avoid resource leaks.

    TryAcquireRawEnvironmentDepthCpuImage(out XRCpuImage)

    Attempt to get the latest raw environment depth CPU image. This provides direct access to the raw pixel data.

    Declaration
    public bool TryAcquireRawEnvironmentDepthCpuImage(out XRCpuImage cpuImage)
    Parameters
    Type Name Description
    XRCpuImage cpuImage

    If this method returns true, an acquired XRCpuImage.

    Returns
    Type Description
    Boolean

    Returns true if the CPU image was acquired. Returns false otherwise.

    Remarks
    Note

    The XRCpuImage must be disposed to avoid resource leaks. This differs from TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) in that it always tries to acquire the raw environment depth image, whereas TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) depends on the value of environmentDepthTemporalSmoothingEnabled.

    TryAcquireSmoothedEnvironmentDepthCpuImage(out XRCpuImage)

    Attempt to get the latest smoothed environment depth CPU image. This provides direct access to the raw pixel data.

    Declaration
    public bool TryAcquireSmoothedEnvironmentDepthCpuImage(out XRCpuImage cpuImage)
    Parameters
    Type Name Description
    XRCpuImage cpuImage

    If this method returns true, an acquired XRCpuImage.

    Returns
    Type Description
    Boolean

    Returns true if the CPU image was acquired. Returns false otherwise.

    Remarks
    Note

    The XRCpuImage must be disposed to avoid resource leaks. This differs from TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) in that it always tries to acquire the smoothed environment depth image, whereas TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) depends on the value of environmentDepthTemporalSmoothingEnabled.

    Update()

    Callback as the manager is being updated.

    Declaration
    public void Update()

    Events

    frameReceived

    An event which fires each time an occlusion camera frame is received.

    Declaration
    public event Action<AROcclusionFrameEventArgs> frameReceived
    Event Type
    Type Description
    Action<AROcclusionFrameEventArgs>
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Monday, May 22, 2023