Class ARSceneView

The Augmented Reality-enabled SceneView control

Inheritance
Object
ARSceneView
Namespace: Esri.ArcGISRuntime.ARToolkit
Assembly: Esri.ArcGISRuntime.ARToolkit.dll
Syntax
public class ARSceneView : SceneView

Properties

| Improve this Doc View Source

ClippingDistance

Gets or sets the clipping distance from the origin camera, beyond which data will not be displayed. Defaults to 0.0. When set to 0.0, there is no clipping distance; all data is displayed.

Declaration
public double ClippingDistance { get; set; }
Property Value
Type Description
Double
Remarks

You can use clipping distance to limit the display of data in world-scale AR or clip data for tabletop AR.

| Improve this Doc View Source

InitialTransformation

Gets the initial transformation used for a table top experience. Defaults to the Identity Matrix.

Declaration
public Mapping.TransformationMatrix InitialTransformation { get; }
Property Value
Type Description
Mapping.TransformationMatrix
See Also
| Improve this Doc View Source

IsTracking

Gets a value indicating whether tracking of location and angles is currently active

Declaration
public bool IsTracking { get; }
Property Value
Type Description
Boolean
See Also
| Improve this Doc View Source

LocationDataSource

The data source used to get device location. Used either in conjuction with device camera tracking data or when device camera tracking is not present or not being used.

Declaration
public LocationDataSource? LocationDataSource { get; set; }
Property Value
Type Description
Nullable<LocationDataSource>
| Improve this Doc View Source

OriginCamera

Gets or sets the viewpoint camera used to set the initial view of the sceneView instead of the device's GPS location via the location data source.

Declaration
public Mapping.Camera OriginCamera { get; set; }
Property Value
Type Description
Mapping.Camera
See Also
| Improve this Doc View Source

RenderVideoFeed

Gets or sets a value indicating whether the background of the ARSceneView is transparent or not. Enabling transparency allows for the camera feed to be visible underneath the ARSceneView.

Declaration
public bool RenderVideoFeed { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

TranslationFactor

Gets or sets translation factor used to support a table top AR experience.

Declaration
public double TranslationFactor { get; set; }
Property Value
Type Description
Double
Remarks

A value of 1 means if the device 1 meter in the real world, it'll move 1 m in the AR world. Set this to 1000 to make 1 m meter 1km in the AR world.

Methods

| Improve this Doc View Source

ARScreenToLocation(Point)

Determines the map point for the given screen point hittesting any surface in the scene.

Declaration
public Geometry.MapPoint? ARScreenToLocation(Point screenPoint)
Parameters
Type Name Description
Point screenPoint

The point in screen coordinates.
Returns
Type Description
Nullable<Geometry.MapPoint>

The map point corresponding to screenPoint.
| Improve this Doc View Source

ResetTracking()

Resets the device tracking, using OriginCamera if it's not null or the device's GPS location via the location data source.

Declaration
public void ResetTracking()
| Improve this Doc View Source

SetInitialTransformation(Mapping.TransformationMatrix)

Sets the initial transformation used to offset the OriginCamera.

Declaration
public void SetInitialTransformation(Mapping.TransformationMatrix transformationMatrix)
Parameters
Type Name Description
Mapping.TransformationMatrix transformationMatrix

Initial transformation matrix
See Also
| Improve this Doc View Source

SetInitialTransformation(Point)

Sets the initial transformation used to offset the OriginCamera. The initial transformation is based on an AR point determined via existing plane hit detection from screenLocation.

Declaration
public bool SetInitialTransformation(Point screenLocation)
Parameters
Type Name Description
Point screenLocation

The screen point to determine the InitialTransformation from.
Returns
Type Description
Boolean

if an AR point cannot be determined, this method will return false.
See Also
| Improve this Doc View Source

StartTrackingAsync(ARLocationTrackingMode)

Starts device tracking.

Declaration
public async Task StartTrackingAsync(ARLocationTrackingMode locationTrackingMode = ARLocationTrackingMode.Ignore)
Parameters
Type Name Description
ARLocationTrackingMode locationTrackingMode
Returns
Type Description
Task
| Improve this Doc View Source

StopTrackingAsync()

Suspends device tracking.

Declaration
public async Task StopTrackingAsync()
Returns
Type Description
Task

Events

| Improve this Doc View Source

IsTrackingStateChanged

Raised if the tracking state changes

Declaration
public event EventHandler<bool> IsTrackingStateChanged
Event Type
Type Description
EventHandler<Boolean>
See Also
| Improve this Doc View Source

OriginCameraChanged

Raised when the OriginCamera has changed

Declaration
public event EventHandler OriginCameraChanged
Event Type
Type Description
EventHandler
See Also
| Improve this Doc View Source

PlanesDetectedChanged

Raises an event indicating whether horizontal planes are currently detected or not

Declaration
public event EventHandler<bool> PlanesDetectedChanged
Event Type
Type Description
EventHandler<Boolean>