AGSSceneViewCommon.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 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 AGSSceneViewCommon.h */ //Required for Globals API doc
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSGeoView.h>
#import <ArcGIS/AGSColor.h>
#import <ArcGIS/AGSCancelable.h>
 
 
 
typedef NS_ENUM(NSInteger, AGSAtmosphereEffect) {
    AGSAtmosphereEffectNone = 0,        
    AGSAtmosphereEffectHorizonOnly = 1, 
    AGSAtmosphereEffectRealistic = 2    
};
 
typedef NS_ENUM(NSInteger, AGSLightingMode) {
    AGSLightingModeNoLight = 0,         
    AGSLightingModeLight = 1,           
    AGSLightingModeLightAndShadows = 2  
};
 
typedef NS_ENUM(NSInteger, AGSSpaceEffect) {
    AGSSpaceEffectStars = 0,        
    AGSSpaceEffectTransparent = 1   
};
 
@class AGSScene;
@class AGSCamera;
@class AGSLocationToScreenResult;
@class AGSCameraController;
@class AGSAnalysisOverlay;
@class AGSSceneViewInteractionOptions;
@class AGSImageOverlay;
 
@interface AGSSceneViewCommon : AGSGeoView
 
#pragma mark -
#pragma mark initializers
 
#pragma mark -
#pragma mark properties
 
@property (nullable, nonatomic, strong, readwrite) AGSScene *scene;
 
@property (nonatomic, assign, readwrite) AGSSpaceEffect spaceEffect;
 
@property (nonatomic, strong, readwrite) AGSColor *ambientLightColor;
 
@property (nonatomic, assign, readwrite) AGSAtmosphereEffect atmosphereEffect;
 
@property (nonatomic, strong, readwrite) NSDate *sunTime;
 
@property (nonatomic, assign, readwrite) AGSLightingMode sunLighting;
 
@property (nullable, nonatomic, strong, readwrite) AGSCameraController *cameraController;
 
@property (nonatomic, strong, readonly) NSMutableArray<AGSAnalysisOverlay *> *analysisOverlays;
 
@property (nonatomic, strong, readwrite) AGSSceneViewInteractionOptions *interactionOptions;
 
@property (nonatomic, assign, readwrite, getter=isManualRendering) BOOL manualRendering;
 
@property (nonatomic, assign, readonly) double fieldOfView;
 
@property (nonatomic, assign, readonly) double fieldOfViewDistortionRatio;
 
@property (nonatomic, strong, readonly) NSMutableArray<AGSImageOverlay *> *imageOverlays;
 
#pragma mark -
#pragma mark methods
 
- (AGSLocationToScreenResult *)locationToScreen:(AGSPoint *)mapPoint;
 
- (AGSPoint *)screenToBaseSurface:(CGPoint)screenPoint;
 
- (AGSCamera *)currentViewpointCamera;
 
- (void)setViewpointCamera:(AGSCamera *)camera;
 
- (id<AGSCancelable>)setViewpointCamera:(AGSCamera *)camera
                             completion:(nullable void(^)(BOOL finished))completion;
 
- (id<AGSCancelable>)setViewpointCamera:(AGSCamera *)camera
                               duration:(double)duration
                             completion:(nullable void(^)(BOOL finished))completion;
 
- (id<AGSCancelable>)screenToLocation:(CGPoint)screenPoint
                           completion:(void(^)(AGSPoint *location))completion;
 
- (void)renderFrame;
 
- (void)setFieldOfViewAndDistortionRatioWithAngle:(double)angle
                                  distortionRatio:(double)distortionRatio;
 
- (void)setFieldOfViewFromLensIntrinsicsWithXFocalLength:(float)xFocalLength
                                            yFocalLength:(float)yFocalLength
                                              xPrincipal:(float)xPrincipal
                                              yPrincipal:(float)yPrincipal
                                              xImageSize:(float)xImageSize
                                              yImageSize:(float)yImageSize
                                       deviceOrientation:(UIDeviceOrientation)deviceOrientation;
 
- (void)setFieldOfViewWithAngle:(double)angle;
 
@end