arsceneview/io.github.sceneview.ar.arcore

Package-level declarations

Types

class ARSession(context: Context, features: Set<Session.Feature> = setOf(), val onResumed: (session: Session) -> Unit, val onPaused: (session: Session) -> Unit, val onConfigChanged: (session: Session, config: Config) -> Unit) : Session

Properties

isTracking

val AugmentedImage.isTracking: Boolean

val Trackable.isTracking: Boolean

val Camera.isTracking: Boolean

Keep the screen unlocked while tracking, but allow it to lock when tracking stops.

position

val Pose.position: Position

quaternion

val Pose.quaternion: Quaternion

rotation

val Pose.rotation: Rotation

transform

val GeospatialPose.transform: Transform

val Pose.transform: Transform

viewTransform

val Camera.viewTransform: Transform

xDirection

val Pose.xDirection: Direction

yDirection

val Pose.yDirection: Direction

zDirection

val Pose.zDirection: Direction

Functions

addAugmentedImage

fun Config.addAugmentedImage(session: Session, name: String, bitmap: Bitmap, widthInMeters: Float? = null)

Adds a single named image with known physical size to the augmented image database from an Android bitmap, with a specified physical width in meters.

canHostCloudAnchor

fun Session.canHostCloudAnchor(cameraNode: ARCameraNode): Boolean

configure

fun Session.configure(config: (Config) -> Unit)

Define the session config used by ARCore

createAnchor

fun Earth.createAnchor(latitude: Double, longitude: Double, altitude: Double, rotation: Rotation): Anchor

fun Earth.createAnchor(latitude: Double, longitude: Double, altitude: Double, quaternion: Quaternion): Anchor

createAnchorOrNull

fun HitResult.createAnchorOrNull(): Anchor?

Creates a new anchor at the hit location.

fun Trackable.createAnchorOrNull(pose: Pose): Anchor?

Creates an anchor that is attached to this trackable, using the given initial pose in the world coordinate space. The type of trackable will determine the semantics of attachment and how the anchor's pose will be updated to maintain this relationship. Note that the relative offset between the pose of multiple anchors attached to a trackable may adjust slightly over time as ARCore updates its model of the world.

distanceTo

fun Pose.distanceTo(other: Pose): Float

Calculate the normal distance from this to the other.

distanceToPlane

fun Pose.distanceToPlane(cameraPose: Pose): Float

Calculate the normal distance to plane from camera Pose

filterTypes

fun List<HitResult>.filterTypes(planeTypes: Set<Plane.Type> = setOf(), point: Boolean = false, depthPoint: Boolean = false, instantPlacementPoint: Boolean = false, trackingStates: Set<TrackingState> = setOf(TrackingState.TRACKING), pointOrientationModes: Set<Point.OrientationMode> = setOf(OrientationMode.ESTIMATED_SURFACE_NORMAL), planePoseInPolygon: Boolean = true, minCameraDistance: Pair<Camera, Float>? = null, predicate: (HitResult) -> Boolean? = null): List<HitResult>

Returns a list containing only elements matching the given parameters and predicate.

findByType

fun List<HitResult>.findByType(planeTypes: Set<Plane.Type> = setOf(), point: Boolean = false, depthPoint: Boolean = false, instantPlacementPoint: Boolean = false, trackingStates: Set<TrackingState> = setOf(TrackingState.TRACKING), pointOrientationModes: Set<Point.OrientationMode> = setOf(OrientationMode.ESTIMATED_SURFACE_NORMAL), planePoseInPolygon: Boolean = true, minCameraDistance: Pair<Camera, Float>? = null, predicate: (HitResult) -> Boolean? = null): HitResult?

Returns the first element matching the given predicate, or null if element was not found.

firstByTypeOrNull

fun List<HitResult>.firstByTypeOrNull(planeTypes: Set<Plane.Type> = setOf(), point: Boolean = false, depthPoint: Boolean = false, instantPlacementPoint: Boolean = false, trackingStates: Set<TrackingState> = setOf(TrackingState.TRACKING), pointOrientationModes: Set<Point.OrientationMode> = setOf(OrientationMode.ESTIMATED_SURFACE_NORMAL), planePoseInPolygon: Boolean = true, minCameraDistance: Pair<Camera, Float>? = null, predicate: (HitResult) -> Boolean? = null): HitResult?

Returns the first element matching the given predicate, or null if element was not found.

fps

fun Frame.fps(other: Frame?): Double

getProjectionTransform

fun Camera.getProjectionTransform(near: Float, far: Float): Mat4

getUpdatedAugmentedFaces

fun Frame.getUpdatedAugmentedFaces(): MutableCollection<AugmentedFace>

Retrieve the frame tracked Augmented Faces.

getUpdatedAugmentedImages

fun Frame.getUpdatedAugmentedImages(): MutableCollection<AugmentedImage>

Retrieve the frame tracked Augmented Images.

getUpdatedPlanes

fun Frame.getUpdatedPlanes(): MutableCollection<Plane>

Retrieve the frame tracked Planes.

getUpdatedStreetscapeGeometries

fun Frame.getUpdatedStreetscapeGeometries(): MutableCollection<StreetscapeGeometry>

Retrieve the frame tracked Streetscape Geometries.

getUpdatedTrackables

fun Frame.getUpdatedTrackables(): MutableCollection<Trackable>

Retrieve all the frame tracked Planes.

hasUpdatedTrackable

inline fun <T : Trackable> Frame.hasUpdatedTrackable(trackable: T): MutableCollection<T>

Retrieve all the frame tracked Planes.

hitTest

fun Frame.hitTest(ray: Ray): List<HitResult>

Similar to Frame.hitTest, but takes an arbitrary ray in world space coordinates instead of a screen-space point.

intervalSeconds

fun Frame.intervalSeconds(other: Frame?): Double

isTrackingPlane

fun Frame.isTrackingPlane(): Boolean

Retrieve if the frame is currently tracking a plane.

isValid

fun HitResult.isValid(planeTypes: Set<Plane.Type> = Plane.Type.values().toSet(), point: Boolean = true, depthPoint: Boolean = true, instantPlacementPoint: Boolean = true, trackingStates: Set<TrackingState> = setOf(TrackingState.TRACKING), pointOrientationModes: Set<Point.OrientationMode> = setOf(OrientationMode.ESTIMATED_SURFACE_NORMAL), planePoseInPolygon: Boolean = true, minCameraDistance: Pair<Camera, Float>? = null, predicate: (HitResult) -> Boolean? = null): Boolean

Check for hit results first valid on provided criteria.