Namespace UnityEngine.XR.ARKit | ARKit XR Plugin | 3.0.4
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.XR.ARKit

    Classes

    ARKitAnchorSubsystem

    The ARKit implementation of the XRAnchorSubsystem. Do not create this directly. Use the SubsystemManager instead.

    ARKitCameraSubsystem

    The camera subsystem implementation for ARKit.

    ARKitImageTrackingSubsystem

    ARKitLoader

    ARKitLoaderBuildProcessor

    The build processor that makes sure that any custom configuration is passed to the ARKit Loader at runtime.

    Custom configuration instances that are stored in EditorBuildSettings are not copied to the target build as they are considered unreferenced assets. In order to get them to the runtime side of things, they need to be serialized to the build app and deserialized at runtime. Previously this would be a manual process requiring the implementor to manually serialize to some location that can then be read from to deserialize at runtime. With the new PlayerSettings Preloaded Assets API we can now just add our asset to the preloaded list and have it be instantiated at app launch.

    Note that the preloaded assets are only notified with Awake, so anything you want or need to do with the asset after launch needs to be handled there.

    More info on APIs used here:

    • EditorBuildSettings
    • PlayerSettings.GetPreloadedAssets
    • PlayerSettings.SetPreloadedAssets

    ARKitLoaderConstants

    Static constants

    ARKitLoaderSettings

    Settings to control the ARKitLoader behavior.

    ARKitParticipantSubsystem

    ARKit implementation of the XRParticipantSubsystem. Do not create this using new. Instead, use the SubsystemManager to enumerate the available s and get or create an instance from the descriptor.

    ARKitRaycastSubsystem

    ARKit implementation of the XRRaycastSubsystem. Do not create this directly. Use the SubsystemManager instead.

    ARKitSessionSubsystem

    ARKit implementation of the XRSessionSubsystem. Do not create this directly. Use the SubsystemManager instead.

    ARKitXRDepthSubsystem

    The ARKit implementation of the XRDepthSubsystem. Do not create this directly. Use the SubsystemManager instead.

    ARKitXRPlaneSubsystem

    The ARKit implementation of the XRPlaneSubsystem. Do not create this directly. Use the SubsystemManager instead.

    ARWorldMapRequestStatusExtensions

    Extension methods for the ARWorldMapRequestStatus enum.

    Structs

    ARCollaborationData

    Represents the Objective-C type ARCollaborationData.

    ARCollaborationDataBuilder

    Use this to construct an ARCollaborationData incrementally from serialized bytes.

    ARWorldMap

    The space-mapping state and set of planes and anchors from an AR session. This is a wrapper for ARKit's ARWorldMap Note: The ARWorldMap must be explicitly disposed to avoid leaking native resources.

    ARWorldMapRequest

    Represents an asynchronous world map request. Use this to determine the status of the request, and get the ARWorldMap once the request is complete.

    OSVersion

    Represents a version number consisting of major, minor, and point compnents. Version numbers are often written as Major.Minor.Point.

    SerializedARCollaborationData

    Represents the serialized form of an ARCollaborationData. Obtain with ToSerialized().

    Enums

    ARCoachingGoal

    Defines the goal for the ARCoachingOverlayView See ARCoachingGoal for details.

    ARCoachingOverlayTransition

    The type of transition used when showing or hiding the ARCoachingOverlay

    ARCollaborationDataPriority

    Defines the priority of ARCollaborationData.

    ARWorldMappingStatus

    Used to determine the suitability of the current session for creating an ARWorldMap. See Apple's documentation for ARWorldMappingStatus for more information.

    ARWorldMapRequestStatus

    The status of a session serialization request. See also and .

    In This Article
    • Classes
    • Structs
    • Enums
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023