Package apple.arkit

Class ARSession

  • All Implemented Interfaces:
    NSObject
    public class ARSession
extends NSObject
    The ARSession class configures and runs different Augmented Reality techniques on a device. API-Since: 11.0

    • Constructor Detail

      • ARSession

        protected ARSession​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • addAnchor

        public void addAnchor​(@NotNull
                      @NotNull ARAnchor anchor)
        Adds an anchor to the session. The anchor will be added in the next frame update.
        Parameters:
        anchor - The anchor to add.

      • allocWithZone

        public static ARSession allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • configuration

        @Nullable
public @Nullable ARConfiguration configuration()
        The configuration currently being used by the session.

      • currentFrame

        @Nullable
public @Nullable ARFrame currentFrame()
        The current frame of the session.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • delegate

        @Nullable
public @Nullable ARSessionDelegate delegate()
        A delegate for receiving ARSession updates.

      • delegateQueue

        @Nullable
public @Nullable dispatch_queue_t delegateQueue()
        The dispatch queue on which the delegate calls are performed. If not provided or nil, delegate calls will be performed on the main queue.

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • new_objc

        public static ARSession new_objc()

      • pause

        public void pause()
        Pauses the session. Once paused, no more updates will be received from the session until run is called again.

      • removeAnchor

        public void removeAnchor​(@NotNull
                         @NotNull ARAnchor anchor)
        Removes an anchor from the session. The anchor will be removed from subsequent frame updates.
        Parameters:
        anchor - The anchor to remove.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • runWithConfiguration

        public void runWithConfiguration​(@NotNull
                                 @NotNull ARConfiguration configuration)
        Runs the session with the provided configuration. Calling run on a session that has already started will transition immediately to using the new configuration.
        Parameters:
        configuration - The configuration to use.

      • runWithConfigurationOptions

        public void runWithConfigurationOptions​(@NotNull
                                        @NotNull ARConfiguration configuration,
                                        long options)
        Runs the session with the provided configuration and options. Calling run on a session that has already started will transition immediately to using the new configuration. Options can be used to alter the default behavior when transitioning configurations.
        Parameters:
        configuration - The configuration to use.
        options - The run options to use.

      • setDelegate_unsafe

        public void setDelegate_unsafe​(@Nullable
                               @Nullable ARSessionDelegate value)
        A delegate for receiving ARSession updates.

      • setDelegate

        public void setDelegate​(@Nullable
                        @Nullable ARSessionDelegate value)
        A delegate for receiving ARSession updates.

      • setDelegateQueue

        public void setDelegateQueue​(@Nullable
                             @Nullable dispatch_queue_t value)
        The dispatch queue on which the delegate calls are performed. If not provided or nil, delegate calls will be performed on the main queue.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • getCurrentWorldMapWithCompletionHandler

        public void getCurrentWorldMapWithCompletionHandler​(@NotNull
                                                    @NotNull ARSession.Block_getCurrentWorldMapWithCompletionHandler completionHandler)
        Copies the current state of the world being tracked by the session. A world map is only provided when running an ARWorldTrackingConfiguration.
        Parameters:
        completionHandler - The completion handler to call when the get has completed. This handler is executed on the session's delegate queue. The completion handler takes the following parameters: worldMap - The current world map or nil if unavailable. error - An error that indicates why the world map is unavailable, or nil if a world map was provided. API-Since: 12.0

      • identifier

        @NotNull
public @NotNull NSUUID identifier()
        Unique identifier of the running session. The identifier may change after calling runWithConfiguration. API-Since: 13.0

      • raycast

        @NotNull
public @NotNull NSArray<? extends ARRaycastResult> raycast​(@NotNull
                                                           @NotNull ARRaycastQuery query)
        Perform a raycast.
        Parameters:
        query - Raycast query used for raycasting.
        Returns:
        List of raycast results, sorted from nearest to farthest (in distance from the camera). The results could be empty if raycast fails. API-Since: 13.0

      • trackedRaycastUpdateHandler

        @Nullable
public @Nullable ARTrackedRaycast trackedRaycastUpdateHandler​(@NotNull
                                                              @NotNull ARRaycastQuery query,
                                                              @NotNull
                                                              @NotNull ARSession.Block_trackedRaycastUpdateHandler updateHandler)
        Perform a tracked raycast. The session performs continuous raycasting and calls the update handler with the updated results. The ARTrackedRaycast object returned can be used to update the raycast with a new raycast query or stop raycasting.
        Parameters:
        query - Raycast query used for raycasting.
        updateHandler - update handler where updated list of results, sorted from nearest to farthest (in distance from the camera) are delivered. updateHandler will be called on session's delegate queue.
        Returns:
        Tracked raycast object used to update or stop raycasting. This could be nil if the raycast fails or if the configuration is not `ARWorldTrackingConfiguration` or its subclasses. API-Since: 13.0

      • updateWithCollaborationData

        public void updateWithCollaborationData​(@NotNull
                                        @NotNull ARCollaborationData collaborationData)
        Update session with collaboration data. Use this to update the session with collaboration data received from other participants.
        Parameters:
        collaborationData - Collaboration data for updating the session.
        See Also:
        API-Since: 13.0

      • captureHighResolutionFrameWithCompletion

        public void captureHighResolutionFrameWithCompletion​(@NotNull
                                                     @NotNull ARSession.Block_captureHighResolutionFrameWithCompletion completion)
        Requests a single, high resolution frame be captured at that moment in time. Some video formats do not support a significantly higher resolution than the streaming camera resolution. Use the @c isRecommendedForHighResolutionFrameCapturing method on the video format to check if the format is recommended.
        Parameters:
        completion - Block being called when the call completes. API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.