ArcGIS Runtime SDK for iOS
100.9

A camera to represent 3D viewpoints of a secene.
Instances of this class represent a camera used to specify 3D viewpoints for AGSSceneView
. It defines the perspective of a scene.
A Camera object can be thought of as a physical camera that one would look through to see a viewable extent and perspective of the Earth. Depending on how you hold the camera and how far away from the ground will determine what you can see. These positions of holding the camera represent the various properties that you can set on the camera. A camera has a location, heading, and a pitch.
AGSScene::baseSurface
. A camera can be created from scratch by specifying location, heading and pitch values. It is immutable which means once it is created it cannot be modified. For convenience, you can produce new cameras by applying offset values to an existing camera.
Instance Methods  
(AGSCamera *)   elevateWithDeltaAltitude: 
(instancetype)   initWithLatitude:longitude:altitude:heading:pitch:roll: 
(instancetype)   initWithLocation:heading:pitch:roll: 
(instancetype)   initWithLookAtPoint:distance:heading:pitch:roll: 
(instancetype)   initWithTransformationMatrix: 
(BOOL)   isEqualToCamera: 
(AGSCamera *)   moveForwardWithDistance: 
(AGSCamera *)   moveToLocation: 
(AGSCamera *)   moveTowardTargetPoint:distance: 
(AGSCamera *)   rotateAroundTargetPoint:deltaHeading:deltaPitch:deltaRoll: 
(AGSCamera *)   rotateToHeading:pitch:roll: 
(AGSCamera *)   zoomTowardTargetPoint:factor: 
Class Methods  
(instancetype)  + cameraWithLatitude:longitude:altitude:heading:pitch:roll: 
(instancetype)  + cameraWithLocation:heading:pitch:roll: 
(instancetype)  + cameraWithLookAtPoint:distance:heading:pitch:roll: 
(instancetype)  + cameraWithTransformationMatrix: 
Properties  
double  heading 
AGSPoint *  location 
double  pitch 
double  roll 
AGSTransformationMatrix *  transformationMatrix 
+ (instancetype) cameraWithLatitude:  (double)  latitude  
longitude:  (double)  longitude  
altitude:  (double)  altitude  
heading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Initialize a new camera based on the provided arguments.
latitude  component of the camera's coordinates 
longitude  component of the camera's coordinates 
altitude  the camera's height in meters from the sea level, may be negative 
heading  in degrees, may be negative. This is the angle, clockwise, from North in an ENU. 
pitch  in degrees, may not be negative. This is the angle of rotation around the Yaxis in an ENU. 
roll  in degrees. This is the angle of rotation around the Xaxis in an ENU. 
+ (instancetype) cameraWithLocation:  (AGSPoint *)  locationPoint  
heading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Initialize a new camera based on the provided arguments.
locationPoint  specifying the camera's coordinates 
heading  in degrees, may be negative. This is the angle, clockwise, from North in an ENU. 
pitch  in degrees, may not be negative. This is the angle of rotation around the Yaxis in an ENU. 
roll  in degrees. This is the angle of rotation around the Xaxis in an ENU. 
+ (instancetype) cameraWithLookAtPoint:  (AGSPoint *)  lookAtPoint  
distance:  (double)  distance  
heading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Initialize a new camera based on the provided arguments and a location to look at.
lookAtPoint
may not be always visible on screen. You can check its visibility using locationToScreen: (AGSSceneViewCommon)
. lookAtPoint  coordinates of the location for the camera to look at 
distance  of the camera from the look at point, in meters; may not be negative 
heading  in degrees, may be negative. This is the angle, clockwise, from North in an ENU. 
pitch  in degrees, may not be negative. This is the angle of rotation around the Yaxis in an ENU. 
roll  in degrees. This is the angle of rotation around the Xaxis in an ENU. 
+ (instancetype) cameraWithTransformationMatrix:  (AGSTransformationMatrix *)  transformationMatrix 
Initialize a new camera based on the transformation matrix.
transformationMatrix  The AGSTransformationMatrix used to create the camera. The transformationMatrix describes the camera's location and the direction it is looking. Using this constructor with the location provided by ARKit/ARCore is necessary for enabling augmented reality. 
 (AGSCamera*) elevateWithDeltaAltitude:  (double)  deltaAltitude 
Creates a new camera that is based on the current camera after adjusting its elevation.
deltaAltitude  that elevation change in meters; can be positive or negative, however the camera will only move as low as the AGSScene::baseSurface allows. 
 (instancetype) initWithLatitude:  (double)  latitude  
longitude:  (double)  longitude  
altitude:  (double)  altitude  
heading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Initialize a new camera based on the provided arguments.
latitude  component of the camera's coordinates 
longitude  component of the camera's coordinates 
altitude  the camera's height in meters from the sea level, may be negative 
heading  in degrees, may be negative. This is the angle, clockwise, from North in an ENU. 
pitch  in degrees, may not be negative. This is the angle of rotation around the Yaxis in an ENU. 
roll  in degrees. This is the angle of rotation around the Xaxis in an ENU. 
 (instancetype) initWithLocation:  (AGSPoint *)  locationPoint  
heading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Initialize a new camera based on the provided arguments.
locationPoint  specifying the camera's coordinates 
heading  in degrees, may be negative. This is the angle, clockwise, from North in an ENU. 
pitch  in degrees, may not be negative. This is the angle of rotation around the Yaxis in an ENU. 
roll  in degrees. This is the angle of rotation around the Xaxis in an ENU. 
 (instancetype) initWithLookAtPoint:  (AGSPoint *)  lookAtPoint  
distance:  (double)  distance  
heading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Initialize a new camera based on the provided arguments and a location to look at.
lookAtPoint
may not be always visible on screen. You can check its visibility using locationToScreen: (AGSSceneViewCommon)
. lookAtPoint  coordinates of the location for the camera to look at 
distance  of the camera from the look at point, in meters; may not be negative 
heading  in degrees, may be negative. This is the angle, clockwise, from North in an ENU. 
pitch  in degrees, may not be negative. This is the angle of rotation around the Yaxis in an ENU. 
roll  in degrees. This is the angle of rotation around the Xaxis in an ENU. 
 (instancetype) initWithTransformationMatrix:  (AGSTransformationMatrix *)  transformationMatrix 
Initialize a new camera based on the transformation matrix.
transformationMatrix  The AGSTransformationMatrix used to create the camera. The transformationMatrix describes the camera's location and the direction it is looking. Using this constructor with the location provided by ARKit/ARCore is necessary for enabling augmented reality. 
 (BOOL) isEqualToCamera:  (AGSCamera *)  other 
Compares whether two cameras are equal.
other  camera to compare this one to 
 (AGSCamera*) moveForwardWithDistance:  (double)  distance 
Creates a new camera that is based on the current camera after moving its location in the direction the camera is facing.
distance  to move in meters, may not be negative 
Create a new camera that is based on the current camera after changing its location.
location  for the new camera 
Create a new camera that is based on the current camera after moving its location in the direction of the given target point.
targetPoint  location to move towards 
distance  to move in meters, may not be negative 
 (AGSCamera*) rotateAroundTargetPoint:  (AGSPoint *)  targetPoint  
deltaHeading:  (double)  deltaHeading  
deltaPitch:  (double)  deltaPitch  
deltaRoll:  (double)  deltaRoll  
Create a new camera that is based on the current camera after rotating around the target point. The target point will not change on the screen if it was on the screen to begin with. The distance between the previous camera location and the target point will be the same as between the new camera location and the target point.
targetPoint  to rotate around 
deltaHeading  the heading change in degrees, may be negative 
deltaPitch  the pitch change in degrees, may be negative 
deltaRoll  the roll change in degrees 
 (AGSCamera*) rotateToHeading:  (double)  heading  
pitch:  (double)  pitch  
roll:  (double)  roll  
Create a new camera that is based on the current camera after changing its heading, pitch, and roll.
heading  for the new camera 
pitch  for the new camera 
roll  for the new camera 
Create a new camera that is based on the current camera after moving its location in the direction of the given target point by the specified zoom factor.
targetPoint  location to move towards 
factor  specifiying how much to move the new camera based on the distance between the current camera location and the target point. For e.g. a factor of 2 will divide that distance in half for the new camera. Negative values will have no effect. 

readnonatomicassign 
The camera's heading in degrees. This is the angle, clockwise, from North in an ENU. Value ranges from 0 to 360 degrees. The heading property can be thought of as a rotation value assuming that you were having the lens of the camera pointing directly at the ground. As you adjust the heading from 0 to 360 degrees, you would rotate (aka. spin) the camera in a counterclockwise fashion.

readnonatomicstrong 
The camera's location in space. It can be thought of as the physical position on/above the Earth that the camera is sitting when you look though it. If the Z
value of the point is 0, that would mean the camera is sitting directly on the surface of the Earth, otherwise the value is assumed to signify meters above sea level.

readnonatomicassign 
The camera's pitch in degrees. This is the angle of rotation around the Yaxis in an ENU. Value ranges from 0 to 180 degrees, where 0 is looking straight down (center of the earth) and 180 looking straight up (towards outer space).

readnonatomicassign 
The camera's roll in degrees. This is the angle of rotation around the Xaxis in an ENU. Value ranges from 0 to 360 degrees, where 0 is horizontal.

readnonatomicstrong 
The camera's AGSTransformationMatrix
. It does not matter if the camera was created with a transformationMatrix, the camera's location and orientation will be converted into an AGSTransformationMatrix
.