ArcGISCamera

Namespace: Esri::GameEngine::MapView
Class: Esri/GameEngine/MapView/ArcGISCamera
Since: 1.0.0

Summary

A camera on a view.

Constructors

ArcGISCamera(const ArcGISPoint&, double, double, double)

Create a camera object.

Since 1.0.0

Arguments
NameTypeConstSummary
locationPoint
Yes

A point geometry containing the location and altitude at which to place the camera.

heading
No

The heading of the camera.

pitch
No

The pitch of the camera. The value must be from 0 to 180 and represents the angle applied to the camera when rotating around its Y axis in the East, North, Up (ENU) ground reference frame. 0 is looking straight down towards the center of the earth, 180 looking straight up towards the sky. Negative pitches are not allowed and the values do not wrap around. If the behavior of a negative pitch is required, then the corresponding transformation with positive pitch can be set instead. For example if heading:0 pitch:-20 roll:0 is required then heading:180 pitch:20 roll:180 can be used instead.

roll
No

The roll of the camera.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The heading of the camera.

No
Yes

The location of the camera.

No
Yes

The pitch of the camera.

No
Yes

The roll of the camera.

Heading

double GetHeading() const

The heading of the camera.

Location

ArcGISPoint GetLocation() const

The location of the camera.

Pitch

double GetPitch() const

The pitch of the camera.

The pitch value must be from 0 to 180 and represents the angle applied to the camera when rotating around its Y axis in the East, North, Up (ENU) ground reference frame. 0 is looking straight down towards the center of the earth, 180 looking straight up towards the sky. Negative pitches are not allowed and the values do not wrap around. If the behavior of a negative pitch is required, then the corresponding transformation with positive pitch can be set instead. For example if heading:0 pitch:-20 roll:0 is required then heading:180 pitch:20 roll:180 can be used instead.

Roll

double GetRoll() const

The roll of the camera.

Methods

SignatureReturn TypeSummary

Elevate(double)

ArcGISCamera

Creates a copy of the camera with the altitude adjusted.

Equals(const ArcGISCamera&)

bool

Tests if this object is equal to a second ArcGISCamera object.

MoveTo(const ArcGISPoint&)

ArcGISCamera

Creates a copy of the camera with the location changed.

RotateTo(double, double, double)

ArcGISCamera

Creates a copy of the camera with a change in pitch, heading and roll to the given angles in degrees

Elevate

ArcGISCamera Elevate(double deltaAltitude) const

Creates a copy of the camera with the altitude adjusted.

Since 1.0.0

Arguments
NameTypeConstSummary
deltaAltitude
No

The altitude delta to apply to the output camera.

Returns ArcGISCamera

A copy of the camera with an elevation delta adjusted by the parameter delta_altitude.

Equals

bool Equals(const ArcGISCamera& otherCamera) const

Tests if this object is equal to a second ArcGISCamera object.

Since 1.0.0

Arguments
NameTypeConstSummary
otherCamera
Yes

The other camera object.

Returns bool

True if the comparison succeeds and the objects are equal, false otherwise.

MoveTo

ArcGISCamera MoveTo(const ArcGISPoint& location) const

Creates a copy of the camera with the location changed.

Since 1.0.0

Arguments
NameTypeConstSummary
location
Yes

The location to move the output camera to.

Returns ArcGISCamera

A copy of the camera with the location changed.

RotateTo

ArcGISCamera RotateTo(double heading, double pitch, double roll) const

Creates a copy of the camera with a change in pitch, heading and roll to the given angles in degrees

Since 1.0.0

Arguments
NameTypeConstSummary
heading
No

The angle in degrees to which the output camera heading will be rotated

pitch
No

The angle in degrees to which the output camera pitch will be rotated. The value must be from 0 to 180 and represents the angle applied to the camera when rotating around its Y axis in the East, North, Up (ENU) ground reference frame. 0 is looking straight down towards the center of the earth, 180 looking straight up towards the sky. Negative pitches are not allowed and the values do not wrap around. If the behavior of a negative pitch is required, then the corresponding transformation with positive pitch can be set instead. For example if heading:0 pitch:-20 roll:0 is required then heading:180 pitch:20 roll:180 can be used instead.

roll
No

The angle in degrees to which the output camera roll will be rotated

Returns ArcGISCamera

A copy of the camera with the position moved

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.