AGSGeoView.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */

 /*@file AGSGeoView.h */ //Required for Globals API doc

#import <ArcGIS/AGSView.h>
#import <ArcGIS/AGSImage.h>
#import <ArcGIS/AGSViewpoint.h>



typedef NS_ENUM(NSInteger, AGSDrawStatus) {
    AGSDrawStatusInProgress = 0,    
    AGSDrawStatusCompleted = 1      
};

@class AGSSpatialReference;
@class AGSLayerViewState;
@class AGSLayer;
@class AGSPoint;
@class AGSGraphicsOverlay;
@class AGSGraphic;
@class AGSIdentifyGraphicsOverlayResult;
@class AGSIdentifyLayerResult;
@protocol AGSGeoElement;
@protocol AGSGeoViewTouchDelegate;
@class AGSCallout;
@class AGSTimeExtent;
@class AGSBookmark;
@class AGSSelectionProperties;

@protocol AGSCancelable;


@interface AGSGeoView : AGSView

#pragma mark -
#pragma mark initializers

#pragma mark -
#pragma mark properties

@property (nonatomic, assign, readonly) AGSDrawStatus drawStatus;

@property (nonatomic, copy, readonly) NSString *attributionText;

@property (nonatomic, assign, readwrite, getter=isAttributionTextVisible) BOOL attributionTextVisible;

@property (nullable, nonatomic, strong, readonly) AGSSpatialReference *spatialReference;

@property (nonatomic, assign, readonly, getter=isNavigating) BOOL navigating;

@property (nonatomic, assign, readonly, getter=isWrapAroundEnabled) BOOL wrapAroundEnabled;

@property (nonatomic, strong, readonly) NSMutableArray<AGSGraphicsOverlay*> *graphicsOverlays;

@property (nonatomic, strong, readonly) AGSCallout *callout;

@property (nullable, nonatomic, weak) IBOutlet id<AGSGeoViewTouchDelegate> touchDelegate;

@property (nullable, nonatomic, copy, readwrite) void (^layerViewStateChangedHandler)(AGSLayer *layer, AGSLayerViewState *layerViewState);

@property (nullable, nonatomic, copy, readwrite) void (^viewpointChangedHandler)(void);

@property (nonatomic, strong, readonly) NSLayoutYAxisAnchor *attributionTopAnchor;

@property (nullable, nonatomic, strong, readwrite) AGSTimeExtent *timeExtent;

@property (nonatomic, strong, readwrite) AGSSelectionProperties *selectionProperties;

#if (TARGET_OS_IPHONE)
#pragma mark - iOS Specific API
@property (nonatomic, assign) BOOL releaseHardwareResourcesWhenBackgrounded;
#endif

#if TARGET_OS_OSX
#pragma mark - Mac OSX Specific API

@property (nonatomic, assign) BOOL trackCursorMovement;
#endif

#pragma mark -
#pragma mark methods

-(id<AGSCancelable>)exportImageWithCompletion:(void(^)(AGSImage *__nullable image, NSError *__nullable error))completion;

-(nullable AGSViewpoint*)currentViewpointWithType:(AGSViewpointType)viewpointType;

-(nullable AGSLayerViewState*)layerViewStateForLayer:(AGSLayer*)layer;

-(id<AGSCancelable>)identifyGraphicsOverlay:(AGSGraphicsOverlay*)graphicsOverlay
                                 screenPoint:(CGPoint)screenPoint
                                   tolerance:(double)tolerance
                            returnPopupsOnly:(BOOL)returnPopupsOnly
                              maximumResults:(NSInteger)maximumResults
                                  completion:(void(^)(AGSIdentifyGraphicsOverlayResult *identifyResult))completion;

-(id<AGSCancelable>)identifyGraphicsOverlay:(AGSGraphicsOverlay*)graphicsOverlay
                                 screenPoint:(CGPoint)screenPoint
                                   tolerance:(double)tolerance
                            returnPopupsOnly:(BOOL)returnPopupsOnly
                                  completion:(void(^)(AGSIdentifyGraphicsOverlayResult *identifyResult))completion;

-(id<AGSCancelable>)identifyGraphicsOverlaysAtScreenPoint:(CGPoint)screenPoint
                                                 tolerance:(double)tolerance
                                          returnPopupsOnly:(BOOL)returnPopupsOnly
                                  maximumResultsPerOverlay:(NSInteger)maximumResultsPerOverlay
                                                completion:(void(^)(NSArray<AGSIdentifyGraphicsOverlayResult*> * __nullable identifyResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)identifyGraphicsOverlaysAtScreenPoint:(CGPoint)screenPoint
                                                 tolerance:(double)tolerance
                                          returnPopupsOnly:(BOOL)returnPopupsOnly
                                                completion:(void(^)(NSArray<AGSIdentifyGraphicsOverlayResult*> * __nullable identifyResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)identifyLayer:(AGSLayer*)layer
                       screenPoint:(CGPoint)screenPoint
                         tolerance:(double)tolerance
                  returnPopupsOnly:(BOOL)returnPopupsOnly
                    maximumResults:(NSInteger)maximumResults
                        completion:(void(^)(AGSIdentifyLayerResult *identifyResult))completion;

-(id<AGSCancelable>)identifyLayer:(AGSLayer*)layer
                       screenPoint:(CGPoint)screenPoint
                         tolerance:(double)tolerance
                  returnPopupsOnly:(BOOL)returnPopupsOnly
                        completion:(void(^)(AGSIdentifyLayerResult *identifyResult))completion;

-(id<AGSCancelable>)identifyLayersAtScreenPoint:(CGPoint)screenPoint
                                       tolerance:(double)tolerance
                                returnPopupsOnly:(BOOL)returnPopupsOnly
                          maximumResultsPerLayer:(NSInteger)maximumResultsPerLayer
                                      completion:(void(^)(NSArray<AGSIdentifyLayerResult*> * __nullable identifyResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)identifyLayersAtScreenPoint:(CGPoint)screenPoint
                                       tolerance:(double)tolerance
                                returnPopupsOnly:(BOOL)returnPopupsOnly
                                      completion:(void(^)(NSArray<AGSIdentifyLayerResult*> * __nullable identifyResults, NSError * __nullable error))completion;


#pragma mark Viewpoint methods

-(void)setViewpoint:(AGSViewpoint*)viewpoint;

-(id<AGSCancelable>)setViewpoint:(AGSViewpoint*)viewpoint completion:(nullable void(^)(BOOL finished))completion;

-(id<AGSCancelable>)setViewpoint:(AGSViewpoint*)viewpoint duration:(double)duration completion:(nullable void(^)(BOOL finished))completion;

-(id<AGSCancelable>)setBookmark:(AGSBookmark*)bookmark completion:(nullable void(^)(BOOL finished))completion;

@end



#pragma mark -
#pragma mark Touch Delegate Methods
#pragma mark -

@protocol AGSGeoViewTouchDelegate 
@optional


#pragma mark Tap

- (void)geoView:(AGSGeoView *)geoView didTapAtScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint;

#pragma mark Touch

-(void)geoView:(AGSGeoView*)geoView didTouchDownAtScreenPoint:(CGPoint)screenPoint
      mapPoint:(AGSPoint*)mapPoint
    completion:(void(^)(BOOL willHandleDrag))completion;


-(void)geoView:(AGSGeoView*)geoView didTouchDragToScreenPoint:(CGPoint)screenPoint
      mapPoint:(AGSPoint*)mapPoint;

 -(void)geoView:(AGSGeoView*)geoView didTouchUpAtScreenPoint:(CGPoint)screenPoint
      mapPoint:(AGSPoint*)mapPoint;

-(void)geoViewDidCancelTouchDrag:(AGSGeoView*)geoView;

#pragma mark Double Tap

-(void)geoView:(AGSGeoView*)geoView didDoubleTapAtScreenPoint:(CGPoint)screenPoint
      mapPoint:(AGSPoint *)mapPoint
    completion:(void(^)(BOOL willHandleDoubleTap))completion;

#pragma mark Long Press

- (void)geoView:(AGSGeoView *)geoView didLongPressAtScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint;

- (void)geoView:(AGSGeoView *)geoView didMoveLongPressToScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint;

- (void)geoView:(AGSGeoView *)geoView didEndLongPressAtScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint;

- (void)geoViewDidCancelLongPress:(AGSGeoView *)geoView;

#ifdef TARGET_OS_IPHONE

#pragma mark Force Touch

- (void)geoView:(AGSGeoView *)geoView didForceTouchAtScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint force:(double)force;

- (void)geoView:(AGSGeoView *)geoView didChangeForceTouchAtScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint force:(double)force;

- (void)geoView:(AGSGeoView *)geoView didEndForceTouchAtScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint *)mapPoint force:(double)force;

- (void)geoViewDidCancelForceTouch:(AGSGeoView *)geoView;

#endif

#if TARGET_OS_OSX

#pragma mark macOS specific delegate methods

-(void)geoView:(AGSGeoView *)geoView didMoveCursorToScreenPoint:(CGPoint)screenPoint mapPoint:(AGSPoint*)mapPoint;

-(void)geoView:(AGSGeoView *)geoView didKeyDown:(NSEvent*)event;

-(void)geoView:(AGSGeoView *)geoView didKeyUp:(NSEvent*)event;

-(BOOL)geoView:(AGSGeoView *)geoView shouldProcessKeyEquivalentEvent:(NSEvent*)event;

#endif

@end