arsceneview/io.github.sceneview.ar/ARCore

ARCore

class ARCore(val onSessionCreated: (session: Session) -> Unit, val onSessionResumed: (session: Session) -> Unit, val onSessionPaused: (session: Session) -> Unit, val onArSessionFailed: (Exception) -> Unit, val onSessionConfigChanged: (session: Session, config: Config) -> Unit)

Manages an ARCore Session using the Android Lifecycle API. Before starting a Session, this class requests installation of Google Play Services for AR if it's not installed or not up to date and asks the user for required permissions if necessary.

Constructors

constructor(onSessionCreated: (session: Session) -> Unit, onSessionResumed: (session: Session) -> Unit, onSessionPaused: (session: Session) -> Unit, onArSessionFailed: (Exception) -> Unit, onSessionConfigChanged: (session: Session, config: Config) -> Unit)

Properties

appSettingsLauncher

lateinit var appSettingsLauncher: ActivityResultLauncher<Intent>

cameraPermissionLauncher

lateinit var cameraPermissionLauncher: ActivityResultLauncher<String>

checkAvailability

var checkAvailability: Boolean

Enable/Disable Google Play Services for AR availability check, auto install and update

checkCameraPermission

var checkCameraPermission: Boolean

lateinit var features: Set<Session.Feature>

onArSessionFailed

val onArSessionFailed: (Exception) -> Unit

onSessionConfigChanged

val onSessionConfigChanged: (session: Session, config: Config) -> Unit

onSessionCreated

val onSessionCreated: (session: Session) -> Unit

onSessionPaused

val onSessionPaused: (session: Session) -> Unit

onSessionResumed

val onSessionResumed: (session: Session) -> Unit

Functions

fun canBeInstalled(context: Context): Boolean

Check to see if we're on a device where ARCore can be installed

checkCameraPermission

fun checkCameraPermission(context: Context, permissionLauncher: ActivityResultLauncher<String>): Boolean

fun checkInstall(activity: ComponentActivity, installRequested: Boolean): Boolean

Checks if ARCore is already installed or attempts to request an install otherwise.

checkPermissionAndInstall

fun checkPermissionAndInstall(activity: ComponentActivity): Boolean

fun create(context: Context, activity: ComponentActivity?, features: Set<Session.Feature>)

fun createSession(context: Context)

Review the API reference for important considerations before calling close() in apps with more complicated lifecycle requirements: Session.close

hasCameraPermission

fun hasCameraPermission(context: Context): Boolean

Check to see we have the necessary permissions for this app.

fun install(activity: ComponentActivity, installRequested: Boolean): Boolean

Returns true if we attempted to request an install.

fun isInstalled(context: Context): Boolean

Check to see we have the necessary permissions for this app.

fun onException(exception: Exception)

fun pause()

fun resume(context: Context, activity: ComponentActivity?)

showCameraPermissionSettings

fun showCameraPermissionSettings(activity: ComponentActivity)