AGSSketchEditor.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
 */
 //Required for Globals API doc

#import <Foundation/Foundation.h>
#import <ArcGIS/AGSDefines.h>
#import <ArcGIS/AGSGeometry.h>



typedef NS_ENUM(NSInteger, AGSSketchCreationMode) {
    AGSSketchCreationModeUnset = -1,
    AGSSketchCreationModePoint,             
    AGSSketchCreationModeMultipoint,        
    AGSSketchCreationModePolyline,          
    AGSSketchCreationModePolygon,           
    AGSSketchCreationModeFreehandPolyline,  
    AGSSketchCreationModeFreehandPolygon,   
    AGSSketchCreationModeRectangle,         
    AGSSketchCreationModeEllipse,           
    AGSSketchCreationModeTriangle,          
    AGSSketchCreationModeArrow              
};

@class AGSSketchStyle;
@class AGSSketchEditConfiguration;
@class AGSPoint;
@class AGSSketchVertex;

AGS_EXTERN NSNotificationName __nonnull const AGSSketchEditorGeometryDidChangeNotification;

@interface AGSSketchEditor : NSObject

#pragma mark -
#pragma mark initializers

+(instancetype)sketchEditor;

#pragma mark -
#pragma mark properties

@property (nonatomic, assign, readonly) AGSSketchCreationMode creationMode;

@property (nonatomic, strong, readonly) NSUndoManager *undoManager;

@property (nonatomic, assign, readwrite) float opacity;

@property (nonatomic, assign, readwrite, getter=isVisible) BOOL visible;

@property (nonatomic, assign, readonly, getter=isStarted) BOOL started;

@property (nullable, nonatomic, strong, readonly) AGSGeometry *geometry;

@property (nonatomic, assign, readonly, getter=isSketchValid) BOOL sketchValid;

@property (nonatomic, strong, readwrite) AGSSketchStyle *style;

@property (nullable, nonatomic, strong, readwrite) AGSSketchEditConfiguration *editConfiguration;

@property (nullable, nonatomic, strong, readwrite) AGSSketchVertex *selectedVertex;

#pragma mark -
#pragma mark methods

#pragma mark start/stop methods

-(BOOL)startWithGeometry:(AGSGeometry*)geometry;


-(BOOL)startWithGeometry:(nullable AGSGeometry*)geometry
            creationMode:(AGSSketchCreationMode)creationMode;

-(BOOL)startWithGeometry:(nullable AGSGeometry*)geometry
            creationMode:(AGSSketchCreationMode)creationMode
       editConfiguration:(nullable AGSSketchEditConfiguration*)editConfiguration;

-(BOOL)startWithCreationMode:(AGSSketchCreationMode)creationMode
           editConfiguration:(nullable AGSSketchEditConfiguration*)editConfiguration;

-(BOOL)startWithCreationMode:(AGSSketchCreationMode)creationMode;


-(BOOL)startWithGeometryType:(AGSGeometryType)geometryType;

-(void)stop;

#pragma mark mutate geometry methods

-(void)clearGeometry;

-(void)replaceGeometry:(AGSGeometry*)geometry;

-(BOOL)insertVertexAfterSelectedVertexWithPoint:(AGSPoint*)point;

-(BOOL)moveSelectedVertexToPoint:(AGSPoint*)point;

-(BOOL)removeSelectedVertex;

@end