ArcGIS Runtime SDK for iOS: AGSSceneViewCommon.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSSceneViewCommon.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25  /*@file AGSSceneViewCommon.h */ //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSGeoView.h>
29 #import <ArcGIS/AGSColor.h>
30 
31 
32 
37 typedef NS_ENUM(NSInteger, AGSAtmosphereEffect) {
41 };
42 
47 typedef NS_ENUM(NSInteger, AGSLightingMode) {
51 };
52 
58 typedef NS_ENUM(NSInteger, AGSSpaceEffect) {
61 };
62 
63 @class AGSScene;
64 @class AGSCamera;
66 @class AGSCameraController;
67 @class AGSAnalysisOverlay;
69 @class AGSImageOverlay;
70 
78 
79 #pragma mark -
80 #pragma mark initializers
81 
82 #pragma mark -
83 #pragma mark properties
84 
88 @property (nullable, nonatomic, strong, readwrite) AGSScene *scene;
89 
94 @property (nonatomic, assign, readwrite) AGSSpaceEffect spaceEffect;
95 
99 @property (nonatomic, strong, readwrite) AGSColor *ambientLightColor;
100 
104 @property (nonatomic, assign, readwrite) AGSAtmosphereEffect atmosphereEffect;
105 
109 @property (nonatomic, strong, readwrite) NSDate *sunTime;
110 
114 @property (nonatomic, assign, readwrite) AGSLightingMode sunLighting;
115 
121 @property (nullable, nonatomic, strong, readwrite) AGSCameraController *cameraController;
122 
128 @property (nonatomic, strong, readonly) NSMutableArray<AGSAnalysisOverlay *> *analysisOverlays;
129 
133 @property (nonatomic, strong, readwrite) AGSSceneViewInteractionOptions *interactionOptions;
134 
142 @property (nonatomic, assign, readwrite, getter=isManualRendering) BOOL manualRendering;
143 
147 @property (nonatomic, assign, readonly) double fieldOfView;
148 
154 @property (nonatomic, assign, readonly) double fieldOfViewDistortionRatio;
155 
165 @property (nonatomic, strong, readonly) NSMutableArray<AGSImageOverlay *> *imageOverlays;
166 
167 #pragma mark -
168 #pragma mark methods
169 
175 - (AGSLocationToScreenResult *)locationToScreen:(AGSPoint *)mapPoint;
176 
183 - (AGSPoint *)screenToBaseSurface:(CGPoint)screenPoint;
184 
190 
195 - (void)setViewpointCamera:(AGSCamera *)camera;
196 
203 - (id<AGSCancelable>)setViewpointCamera:(AGSCamera *)camera
204  completion:(nullable void(^)(BOOL finished))completion;
205 
213 - (id<AGSCancelable>)setViewpointCamera:(AGSCamera *)camera
214  duration:(double)duration
215  completion:(nullable void(^)(BOOL finished))completion;
216 
227 - (id<AGSCancelable>)screenToLocation:(CGPoint)screenPoint
228  completion:(void(^)(AGSPoint *location))completion;
229 
234 - (void)renderFrame;
235 
244 - (void)setFieldOfViewAndDistortionRatioWithAngle:(double)angle
245  distortionRatio:(double)distortionRatio;
246 
258 - (void)setFieldOfViewFromLensIntrinsicsWithXFocalLength:(float)xFocalLength
259  yFocalLength:(float)yFocalLength
260  xPrincipal:(float)xPrincipal
261  yPrincipal:(float)yPrincipal
262  xImageSize:(float)xImageSize
263  yImageSize:(float)yImageSize
264  deviceOrientation:(UIDeviceOrientation)deviceOrientation;
265 
270 - (void)setFieldOfViewWithAngle:(double)angle;
271 
272 @end
273 
274 
#define AGSColor
Definition: AGSColor.h:34
AGSSpaceEffect
Definition: AGSSceneViewCommon.h:58
@ AGSSpaceEffectStars
Definition: AGSSceneViewCommon.h:59
@ AGSSpaceEffectTransparent
Definition: AGSSceneViewCommon.h:60
AGSAtmosphereEffect
Definition: AGSSceneViewCommon.h:37
@ AGSAtmosphereEffectHorizonOnly
Definition: AGSSceneViewCommon.h:39
@ AGSAtmosphereEffectNone
Definition: AGSSceneViewCommon.h:38
@ AGSAtmosphereEffectRealistic
Definition: AGSSceneViewCommon.h:40
AGSLightingMode
Definition: AGSSceneViewCommon.h:47
@ AGSLightingModeNoLight
Definition: AGSSceneViewCommon.h:48
@ AGSLightingModeLightAndShadows
Definition: AGSSceneViewCommon.h:50
@ AGSLightingModeLight
Definition: AGSSceneViewCommon.h:49
NSMutableArray< AGSAnalysisOverlay * > * analysisOverlays
Definition: AGSSceneViewCommon.h:128
Manages the display of one or more Analyses on a scene view.
Definition: AGSAnalysisOverlay.h:40
A base class for controllers which manage the camera of AGSSceneView.
Definition: AGSCameraController.h:37
A camera to represent 3D viewpoints of a scene.
Definition: AGSCamera.h:50
A base class for all views that can display geographic content on screen.
Definition: AGSGeoView.h:70
An overlay that contains a frame with an image to display in the view.
Definition: AGSImageOverlay.h:56
Result of a location-to-screen operation on AGSSceneView.
Definition: AGSLocationToScreenResult.h:52
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
A scene containing 3D geographic content.
Definition: AGSScene.h:69
A base class for AGSSceneView.
Definition: AGSSceneViewCommon.h:78
BOOL manualRendering
Definition: AGSSceneViewCommon.h:142
AGSScene * scene
Definition: AGSSceneViewCommon.h:88
AGSCamera * currentViewpointCamera()
AGSSceneViewInteractionOptions * interactionOptions
Definition: AGSSceneViewCommon.h:133
double fieldOfView
Definition: AGSSceneViewCommon.h:147
AGSSpaceEffect spaceEffect
Definition: AGSSceneViewCommon.h:94
AGSAtmosphereEffect atmosphereEffect
Definition: AGSSceneViewCommon.h:104
double fieldOfViewDistortionRatio
Definition: AGSSceneViewCommon.h:154
AGSLightingMode sunLighting
Definition: AGSSceneViewCommon.h:114
AGSColor * ambientLightColor
Definition: AGSSceneViewCommon.h:99
AGSCameraController * cameraController
Definition: AGSSceneViewCommon.h:121
NSDate * sunTime
Definition: AGSSceneViewCommon.h:109
NSMutableArray< AGSImageOverlay * > * imageOverlays
Definition: AGSSceneViewCommon.h:165
Options to configure Scene View user interactions.
Definition: AGSSceneViewInteractionOptions.h:38
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38