ArcGIS Runtime SDK for iOS: AGSOrbitGeoElementCameraController.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSOrbitGeoElementCameraController.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 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSCameraController.h>
27 
28 @protocol AGSCancelable, AGSGeoElement;
29  //Required for Globals API doc
31 
41 
42 
43 
44 #pragma mark -
45 #pragma mark initializers
46 
47 
48 
62 -(instancetype)initWithTargetGeoElement:(id<AGSGeoElement>)targetGeoElement distance:(double)distance;
63 
78 +(instancetype)orbitGeoElementCameraControllerWithTargetGeoElement:(id<AGSGeoElement>)targetGeoElement distance:(double)distance;
79 
80 #pragma mark -
81 #pragma mark properties
82 
86 @property (nonatomic, assign, readwrite) double cameraDistance;
87 
97 @property (nonatomic, assign, readwrite) double cameraHeadingOffset;
98 
105 @property (nonatomic, assign, readwrite) double cameraPitchOffset;
106 
111 @property (nonatomic, assign, readwrite, getter=isAutoHeadingEnabled) BOOL autoHeadingEnabled;
112 
116 @property (nonatomic, assign, readwrite, getter=isAutoPitchEnabled) BOOL autoPitchEnabled;
117 
121 @property (nonatomic, assign, readwrite, getter=isAutoRollEnabled) BOOL autoRollEnabled;
122 
126 @property (nonatomic, assign, readwrite, getter=isCameraDistanceInteractive) BOOL cameraDistanceInteractive;
127 
131 @property (nonatomic, assign, readwrite, getter=isCameraHeadingOffsetInteractive) BOOL cameraHeadingOffsetInteractive;
132 
136 @property (nonatomic, assign, readwrite, getter=isCameraPitchOffsetInteractive) BOOL cameraPitchOffsetInteractive;
137 
142 @property (nonatomic, assign, readwrite) double maxCameraDistance;
143 
148 @property (nonatomic, assign, readwrite) double maxCameraHeadingOffset;
149 
154 @property (nonatomic, assign, readwrite) double maxCameraPitchOffset;
155 
160 @property (nonatomic, assign, readwrite) double minCameraDistance;
161 
166 @property (nonatomic, assign, readwrite) double minCameraHeadingOffset;
167 
172 @property (nonatomic, assign, readwrite) double minCameraPitchOffset;
173 
177 @property (nonatomic, strong, readonly) id<AGSGeoElement> targetGeoElement;
178 
183 @property (nonatomic, assign, readwrite) float targetVerticalScreenFactor;
184 
188 @property (nonatomic, assign, readwrite) double targetOffsetX;
189 
193 @property (nonatomic, assign, readwrite) double targetOffsetY;
194 
198 @property (nonatomic, assign, readwrite) double targetOffsetZ;
199 
200 #pragma mark -
201 #pragma mark methods
202 
213 -(id<AGSCancelable>)moveCameraWithDistanceDelta:(double)distanceDelta
214  headingDelta:(double)headingDelta
215  pitchDelta:(double)pitchDelta
216  duration:(NSTimeInterval)duration
217  completion:(nullable void(^)(BOOL finished))completion;
218 
229 -(id<AGSCancelable>)setTargetOffsetX:(double)x
230  targetOffsetY:(double)y
231  targetOffsetZ:(double)z
232  duration:(NSTimeInterval)duration
233  completion:(nullable void(^)(BOOL finished))completion;
234 
235 
236 
237 @end
A base class for controllers which manage the camera of AGSSceneView.
Definition: AGSCameraController.h:37
A controller which allows a scene view's camera to orbit a geo-element.
Definition: AGSOrbitGeoElementCameraController.h:41
float targetVerticalScreenFactor
Definition: AGSOrbitGeoElementCameraController.h:183
double minCameraHeadingOffset
Definition: AGSOrbitGeoElementCameraController.h:166
double cameraHeadingOffset
Definition: AGSOrbitGeoElementCameraController.h:97
BOOL cameraHeadingOffsetInteractive
Definition: AGSOrbitGeoElementCameraController.h:131
double cameraPitchOffset
Definition: AGSOrbitGeoElementCameraController.h:105
BOOL autoPitchEnabled
Definition: AGSOrbitGeoElementCameraController.h:116
double maxCameraDistance
Definition: AGSOrbitGeoElementCameraController.h:142
double maxCameraHeadingOffset
Definition: AGSOrbitGeoElementCameraController.h:148
double minCameraDistance
Definition: AGSOrbitGeoElementCameraController.h:160
BOOL cameraDistanceInteractive
Definition: AGSOrbitGeoElementCameraController.h:126
BOOL autoRollEnabled
Definition: AGSOrbitGeoElementCameraController.h:121
double minCameraPitchOffset
Definition: AGSOrbitGeoElementCameraController.h:172
double maxCameraPitchOffset
Definition: AGSOrbitGeoElementCameraController.h:154
double targetOffsetY
Definition: AGSOrbitGeoElementCameraController.h:193
double cameraDistance
Definition: AGSOrbitGeoElementCameraController.h:86
BOOL autoHeadingEnabled
Definition: AGSOrbitGeoElementCameraController.h:111
double targetOffsetZ
Definition: AGSOrbitGeoElementCameraController.h:198
BOOL cameraPitchOffsetInteractive
Definition: AGSOrbitGeoElementCameraController.h:136
id< AGSGeoElement > targetGeoElement
Definition: AGSOrbitGeoElementCameraController.h:177
double targetOffsetX
Definition: AGSOrbitGeoElementCameraController.h:188
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
An abstract representation of geographic entities on a map.
Definition: AGSGeoElement.h:43