ArcGIS Runtime SDK for iOS: AGSImageOverlay Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSImageOverlay Class Reference

Description

An overlay that contains a frame with an image to display in the view.

Currently, this feature is supported in an AGSSceneView (3D) only. The overlay can contain exactly one image at any given time. Multiple overlays, however, can be added and rendered at the same time on the AGSSceneView.

An AGSImageOverlay can be used to quickly render frequently changing images. For example, rendering realtime sensor data, such as weather, where each static image represents a single frame from the radar. In this workflow, images are constantly updated via a new AGSImageFrame each time new data is available. This provides a fast-refreshing workflow where the underlying images are frequently updated as new data comes in.

Since AGSImageOverlay does not support the rich processing and rendering capabilities of an AGSRasterLayer, you should use AGSRaster and AGSRasterLayer for workflows that require static image rendering, analysis, and persistence.

Image overlays are rendered above all other layers in the scene, draped on the surface, and below any graphics overlays in the scene view.

See also
AGSImageFrame, AGSSceneView
Since
100.8
Inheritance diagram for AGSImageOverlay:
AGSObject

Instance Methods

(instancetype) - init
 
(instancetype) - initWithImageFrame:
 

Class Methods

(instancetype) + imageOverlay
 
(instancetype) + imageOverlayWithImageFrame:
 

Properties

AGSEnvelopeextent
 
AGSImageFrameimageFrame
 
float opacity
 
BOOL visible
 

Method Documentation

◆ imageOverlay

+ (instancetype) imageOverlay

Creates an AGSImageOverlay.

Since
100.8

◆ imageOverlayWithImageFrame:

+ (instancetype) imageOverlayWithImageFrame: (AGSImageFrame *)  imageFrame

Creates an AGSImageOverlay that contains an AGSImageFrame.

Parameters
imageFrameThe AGSImageFrame of the AGSImageOverlay.
Since
100.8

◆ init

- (instancetype) init

Creates an AGSImageOverlay.

Since
100.8

◆ initWithImageFrame:

- (instancetype) initWithImageFrame: (AGSImageFrame *)  imageFrame

Creates an AGSImageOverlay that contains an AGSImageFrame.

Parameters
imageFrameThe AGSImageFrame of the AGSImageOverlay.
Since
100.8

Property Documentation

◆ extent

- (AGSEnvelope*) extent
readnonatomicstrong

The extent of the AGSImageOverlay.

The spatial reference of the extent matches the extent of the AGSSceneView that contains the image overlay.

Since
100.8

◆ imageFrame

- (AGSImageFrame*) imageFrame
readwritenonatomicstrong

The AGSImageFrame contained in the AGSImageOverlay.

Since
100.8

◆ opacity

- (float) opacity
readwritenonatomicassign

The opacity for the AGSImageOverlay. Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.

Since
100.8

◆ visible

- (BOOL) visible
readwritenonatomicassign

The visibility of the AGSImageOverlay.

Since
100.8