arcgis-maps-kotlin/com.arcgismaps.mapping.view/SceneView

SceneView

class SceneView(context: Context, attrs: AttributeSet?) : GeoView

A scene view object. The scene view is how a scene is displayed on a screen. The scene view will be updated when the scene changes.

Constructors

SceneView

fun SceneView(context: Context)

SceneView

fun SceneView(context: Context, attrs: AttributeSet?)

Properties

ambientLightColor

var ambientLightColor: Color

The color of the scene view's ambient light.

analysisOverlays

val analysisOverlays: MutableList<AnalysisOverlay>

A collection of analysis overlays that render the results of 3D visual analysis on the scene view. Dynamic 3D analyses, such as com.arcgismaps.analysis.LineOfSight and com.arcgismaps.analysis.Viewshed, generate visual results that are rendered on the scene view. To display the results, add the com.arcgismaps.analysis.Analysis to a collection of AnalysisOverlay.analyses and then add the AnalysisOverlay to the collection of SceneView.analysisOverlays.

atmosphereEffect

var atmosphereEffect: AtmosphereEffect

The effect applied to the scene's atmosphere. The default value is AtmosphereEffect.HorizonOnly.

cameraController

var cameraController: CameraController

The camera controller manages the position, orientation, and movement of the camera for a SceneView. The controller handles user-interaction with the SceneView and updates the Camera. You can assign a CameraController with a specific navigation mode that is free roaming, following a moving target, fixed on a stationary target, or that supports AR transformation matrices. For more information, see CameraController.

fieldOfView

val fieldOfView: Double?

The horizontal field of view of the scene view in degrees.

fieldOfViewDistortionRatio

val fieldOfViewDistortionRatio: Double

The ratio indicates how much the vertical field of view is distorted.

imageOverlays

val imageOverlays: MutableList<ImageOverlay>

A collection of overlays for displaying images in the scene view. An image overlay collection cannot belong to more that one SceneView.

interactionOptions

open override var interactionOptions: SceneViewInteractionOptions

The InteractionOptions for this SceneView.

isManualRenderingEnabled

var isManualRenderingEnabled: Boolean = false

Indicates whether manual rendering is enabled or not.

onDoubleTap

open override val onDoubleTap: SharedFlow<DoubleTapEvent>

A SharedFlow which emits DoubleTapEvent when the user double taps on the screen.

onDown

open override val onDown: SharedFlow<DownEvent>

A SharedFlow which emits a DownEvent when the user first presses on the screen.

onLongPress

open override val onLongPress: SharedFlow<LongPressEvent>

A SharedFlow which emits LongPressEvent when a user holds a pointer on the screen.

onPan

open override val onPan: SharedFlow<PanChangeEvent>

A SharedFlow which emits PanChangeEvent when a user drags a pointer or pointers across the screen.

onSingleTapConfirmed

open override val onSingleTapConfirmed: SharedFlow<SingleTapConfirmedEvent>

A SharedFlow which emits SingleTapConfirmedEvents when the user taps once on the screen.

onTwoPointerTap

open override val onTwoPointerTap: SharedFlow<TwoPointerTapEvent>

A SharedFlow which emits TwoPointerTapEvent when a user taps two pointers on the screen.

onUp

open override val onUp: SharedFlow<UpEvent>

A SharedFlow which emits an UpEvent when the user removes all their pointers from the screen.

scene

var scene: ArcGISScene?

The scene that is currently set to the scene view.

spaceEffect

var spaceEffect: SpaceEffect

The visual effect of outer space in the scene view. The modes are black with stars or transparent. The default value is SpaceEffect.Stars.

sunLighting

var sunLighting: LightingMode

The type of ambient sunlight and shadows in the scene view.

sunTime

var sunTime: Instant

The position of the sun in the scene view based on a specific date and time.

Inherited properties

attributionText

val attributionText: StateFlow<String>

The attribution text for the data that is currently displayed in the GeoView.

callout

val callout: Callout

drawStatus

val drawStatus: StateFlow<DrawStatus>

The GeoView's current draw status.

graphicsOverlays

lateinit var graphicsOverlays: MutableList<GraphicsOverlay>

A collection containing the GraphicsOverlays.

isAttributionBarVisible

var isAttributionBarVisible: Boolean

True if attribution bar is visible in the GeoView, false otherwise.

isNavigating

val isNavigating: Boolean

Is the Geoview currently navigating.

isWrapAroundEnabled

val isWrapAroundEnabled: Boolean

True if the Geoview currently has wraparound turned on, false otherwise.

labeling

var labeling: ViewLabelProperties

layerViewStateChanged

val layerViewStateChanged: SharedFlow<GeoView.GeoViewLayerViewStateChanged>

Sets a callback to be invoked when the layer view state changes for the view.

navigationChanged

val navigationChanged: SharedFlow<Boolean>

Sets a callback to be invoked when navigation state has changed for the view.

onAttributionBarLayoutChanged

val onAttributionBarLayoutChanged: SharedFlow<AttributionBarLayoutChangeEvent>

Called when the attribution bar's position or size changes due to expanding, collapsing, or inset changes.

selectionProperties

var selectionProperties: SelectionProperties

spatialReference

val spatialReference: StateFlow<SpatialReference?>

The spatial reference for the Geoview.

timeExtent

val timeExtent: StateFlow<TimeExtent?>

The current TimeExtent of the GeoView. The Time Extent of the GeoView defines how time-enabled data is displayed. Participating layers filter their data to only show data within the time extent set on the GeoView (see TimeAware for details). The range of the time extent includes the start and end values (a feature at 10/24/2016 would be included in a time extent defined as 10/24/2016 - 11/14/2016). Time filtering is not enabled until a non-null time extent is set on the GeoView. When the time extent is null on the GeoView, no time filtering is applied and all content is rendered.

viewpointChanged

val viewpointChanged: SharedFlow<Unit>

A SharedFlow which notifies when the viewpoint of the view has changed.

Functions

getCurrentViewpointCamera

fun getCurrentViewpointCamera(): Camera

Retrieves the camera that displays the current viewpoint.

locationToScreen

fun locationToScreen(point: Point): LocationToScreenResult?

Converts a location in map coordinates to a point in screen coordinates relative to the upper-left corner of the scene view.

onCreate

open override fun onCreate(owner: LifecycleOwner)

onDestroy

open override fun onDestroy(owner: LifecycleOwner)

onPause

open override fun onPause(owner: LifecycleOwner)

onResume

open override fun onResume(owner: LifecycleOwner)

renderFrame

fun renderFrame()

Draws the scene based on a user-defined pulse.

screenToBaseSurface

fun screenToBaseSurface(screenCoordinate: ScreenCoordinate): Point?

Converts a screen coordinate (in pixels) to a point on the base surface of the scene within the scene view's spatial reference.

screenToLocation

suspend fun screenToLocation(screenCoordinate: ScreenCoordinate): Result<Point>

Asynchronously converts a screen coordinate relative to the upper-left corner of the scene view to a location in map coordinates.

setFieldOfView

fun setFieldOfView(angle: Double)

Sets the field of view on the scene view in degrees

setFieldOfViewAndDistortionRatio

fun setFieldOfViewAndDistortionRatio(angle: Double, distortionRatio: Double)

Sets the field of view on the scene view in degrees and determines how much the vertical field of view is distorted.

setFieldOfViewFromLensIntrinsics

fun setFieldOfViewFromLensIntrinsics(xFocalLength: Float, yFocalLength: Float, xPrincipal: Float, yPrincipal: Float, xImageSize: Float, yImageSize: Float, deviceOrientation: DeviceOrientation)

Matches the field of view of the scene view to the field of view of a camera lens using the lens characteristics. All parameter values must be greater than 0.

setViewpointCamera

fun setViewpointCamera(camera: Camera)

Updates the display to the viewpoint specified by the given camera.

setViewpointCameraAnimated