ArcGISLocalSceneViewController class final
A view that displays 3D content from an ArcGISScene with a viewing mode of SceneViewingMode.local.
Local scenes are used to view local 3D data in projected coordinate systems.
To display a local scene, add this view to your app and assign a local scene to it via ArcGISLocalSceneViewController.arcGISScene. This view loads the local scene and its content, such as the GeoModel.basemap and the GeoModel.operationalLayers, and then renders the local scene on screen.
FloorAware is not supported in this view. Any layer floor aware configurations will be ignored.
Navigation:
Pan, zoom, and rotate user interactions are supported in this view using touch, mouse, keyboard or pen/pencil.
Programmatic Navigation:
The visible area (Viewpoint) of the local scene view is defined by the visible extent of the local scene. You can programmatically set the visible area by specifying a viewpoint. For example, GeoViewController.setViewpoint sets the visible area to a viewpoint, or ArcGISLocalSceneViewController.setViewpointCamera sets the visible area by moving the camera. In addition, you can change the visible area with a smooth transition animation by calling GeoView.setViewpointAsync(Viewpoint) or ArcGISLocalSceneViewController.setViewpointCameraAnimated.
View errors:
This view supports three different errors to give the user helpful information.
The errors are:
- ArcGISLocalSceneViewController.onCriticalErrorChanged: The most severe, this error means the view is unusable and cannot recover.
- GeoViewController.onGeoModelErrorChanged: Less severe, this error means the view is usable but nothing is displaying. Nothing is displaying because something is not configured correctly with the geo model.
- ArcGISLocalSceneViewController.onWarningsChanged: The least severe, these warnings mean the view is usable but something may not look correct or as expected.
- Inheritance
-
- Object
- GeoViewController
- ArcGISLocalSceneViewController
Properties
-
analysisOverlays
→ List<
AnalysisOverlay> -
A collection of analysis overlays that render the analysis results on the
view.
no setterinherited
- arcGISScene ↔ ArcGISScene?
-
The local scene that the local scene view is displaying.
getter/setter pair
- attributionText → String
-
The attribution text for the data that is currently displayed in the
GeoViewController.
no setterinherited
- criticalError → ArcGISException?
-
The critical error on the view.
no setter
- deterministicRenderingIsEnabled ↔ bool
-
getter/setter pair
- drawStatus → DrawStatus
-
The current drawing status of the content displayed in the
GeoViewController.
no setterinherited
- geoModelError → ArcGISException?
-
The geo model error on the view.
no setterinherited
-
graphicsOverlays
→ List<
GraphicsOverlay> -
A collection of GraphicsOverlay objects used to display graphics on top
of the view's content.
no setterinherited
- grid ↔ Grid?
-
A coordinate system grid to display on top of the GeoViewController.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
imageOverlays
→ List<
ImageOverlay> -
A collection of overlays for displaying images in the view.
no setterinherited
- interactionOptions → InteractionOptions
-
Options for controlling how user interactions behave.
no setter
- isAttributionTextVisible ↔ bool
-
True if attribution text is visible in the GeoViewController, false
otherwise.
getter/setter pairinherited
-
True if the GeoViewController is animating a viewpoint change or a
navigation gesture is in progress, otherwise false.
no setterinherited
- isWrapAroundEnabled → bool
-
True if continuous panning across the international date line is enabled
in the GeoViewController, false otherwise.
no setterinherited
- labeling ↔ ViewLabelProperties
-
The view label properties.
getter/setter pairinherited
-
onAnalysisViewStateChanged
→ Stream<
({Analysis analysis, AnalysisViewState viewState})> -
Invokes the callback when the state of any analysis in the
GeoViewController changes.
no setterinherited
-
onAttributionChanged
→ Stream<
String> -
Invokes the callback when the attribution text of the GeoViewController
changes.
no setterinherited
-
onCriticalErrorChanged
→ Stream<
ArcGISException> -
Invokes the callback when a critical error changes on the local scene
view.
no setter
-
onDrawStatusChanged
→ Stream<
DrawStatus> -
Invokes the callback when the draw status of the GeoViewController
changes.
no setterinherited
-
onGeoModelErrorChanged
→ Stream<
ArcGISException?> -
Invokes the callback when a geo model error changes on the geo view.
no setterinherited
-
onLayerViewStateChanged
→ Stream<
({Layer layer, LayerViewState layerViewState})> -
Invokes the callback when the layer view state of any layer in the
GeoViewController changes.
no setterinherited
-
Invokes the callback when the navigation state of the GeoViewController
changes.
no setterinherited
-
onSpatialReferenceChanged
→ Stream<
SpatialReference?> -
Invokes the callback when the spatial reference of the GeoViewController
changes.
no setterinherited
-
onTimeExtentChanged
→ Stream<
TimeExtent?> -
Invokes the callback when the time extent of the GeoViewController
changes.
no setterinherited
-
onViewpointChanged
→ Stream<
void> -
Invokes the callback when the viewpoint of the GeoViewController has
changed.
no setterinherited
-
onWarningsChanged
→ Stream<
List< ArcGISException> > -
Invokes the callback when the warnings change on the local scene view.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectionProperties ↔ SelectionProperties
-
The selection properties for all graphic overlays and selectable layers
within the GeoViewController.
getter/setter pairinherited
- spatialReference → SpatialReference?
-
The spatial reference defines the coordinate system used by the map or
scene in the GeoViewController.
no setterinherited
- timeExtent ↔ TimeExtent?
-
The current TimeExtent of the GeoViewController.
getter/setter pairinherited
-
warnings
→ List<
ArcGISException> -
The warnings on the local scene view.
no setter
Methods
-
dispose(
) → void -
This function cleans up properties of this controller before garbage
collection happens. This function should be overriden by subclasses that
have other properties that need to be cleaned up.
inherited
-
exportImage(
) → Future< ArcGISImage> -
Exports an image snapshot of the current GeoViewController.
inherited
-
getAnalysisViewState(
Analysis analysis) → AnalysisViewState? -
Retrieves the analysis' state in the view.
inherited
-
getCurrentViewpoint(
ViewpointType viewpointType) → Viewpoint? -
Retrieves the current Viewpoint of the GeoViewController.
inherited
-
getCurrentViewpointCamera(
) → Camera - Retrieves the camera that displays the current viewpoint.
-
getLayerViewState(
Layer layer) → LayerViewState? -
Retrieves the layer's state in the GeoViewController.
inherited
-
identifyGraphicsOverlay(
GraphicsOverlay graphicsOverlay, {required Offset screenPoint, required double tolerance, bool returnPopupsOnly = false, int? maximumResults = 1}) → Future< IdentifyGraphicsOverlayResult> -
Identifies a limited number of graphics in the specified graphics overlay,
at the given screen point.
inherited
-
identifyGraphicsOverlays(
{required Offset screenPoint, required double tolerance, bool returnPopupsOnly = false, int? maximumResultsPerOverlay = 1}) → Future< List< IdentifyGraphicsOverlayResult> > -
Identifies a limited number of graphics in all graphics overlays, at the
given screen point.
inherited
-
identifyLayer(
Layer layer, {required Offset screenPoint, required double tolerance, bool returnPopupsOnly = false, int? maximumResults = 1}) → Future< IdentifyLayerResult> -
Identifies a limited number of geoelements in the specified layer or
sublayer, at the given screen point.
inherited
-
identifyLayers(
{required Offset screenPoint, required double tolerance, bool returnPopupsOnly = false, int? maximumResultsPerLayer = 1}) → Future< List< IdentifyLayerResult> > -
Identifies a limited number of geoelements at the given screen point, in
each identifiable layer or sublayer in the GeoViewController's
ArcGISMap or ArcGISScene.
inherited
-
locationToScreen(
{required ArcGISPoint mapPoint}) → LocationToScreenResult? - Converts a location in map coordinates to a point in screen coordinates relative to the upper-left corner of the local scene view.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
screenToBaseSurface(
{required Offset screen}) → ArcGISPoint? - Converts a screen coordinate to a location on the base surface in scene coordinates, considering only the scene's base surface and ignoring other scene content.
-
screenToLocation(
{required Offset screen}) → Future< ArcGISPoint> - Converts a screen coordinate to a location in scene coordinates, considering both the scene's base surface and other scene content.
-
setBookmark(
Bookmark bookmark) → Future< bool> -
Sets the Viewpoint of the GeoViewController to the
Bookmark.viewpoint.
inherited
-
setViewpoint(
Viewpoint viewpoint) → void -
Pan or zoom the GeoViewController to the specified Viewpoint location.
inherited
-
setViewpointAnimated(
Viewpoint viewpoint, {double? duration, AnimationCurve? curve}) → Future< bool> -
Pans or zooms the local scene view using animation to the specified
viewpoint location asynchronously. The animation takes place over the
specified duration. The animation curve defines the animation easing
function.
inherited
-
setViewpointCamera(
Camera camera) → void - Changes the display to the viewpoint specified by the given camera.
-
setViewpointCameraAnimated(
{required Camera camera, double duration = 0.25}) → Future< bool> - Animates the display to the viewpoint specified by the given camera using the specified duration to arrive.
-
setViewpointWithDurationAndCurve(
{required Viewpoint viewpoint, required double durationSeconds, required AnimationCurve curve}) → Future< bool> - Pans or zooms the local scene view using animation to the specified viewpoint location asynchronously. The animation takes place over the specified duration. The animation curve defines the animation easing function.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited