KmlViewpoint Class

Member Function Documentation

KmlViewpoint::KmlViewpoint()

Default constructor.

Use this constructor to create a KML viewpoint for Qt. This is provided for convenience only and will construct an empty object.

KmlViewpoint::KmlViewpoint(const Esri::ArcGISRuntime::KmlViewpoint &other)

Copy constructor from the other KmlViewpoint.

KmlViewpoint::KmlViewpoint(Esri::ArcGISRuntime::KmlViewpoint &&other)

Move constructor from the other KmlViewpoint.

KmlViewpoint::~KmlViewpoint()

Destructor.

Esri::ArcGISRuntime::KmlAltitudeMode KmlViewpoint::altitudeMode() const

Returns the KML viewpoint's altitude mode.

Altitude mode indicates how the altitude values relate to the ground or sea level.

[static, since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::KmlViewpoint KmlViewpoint::createCameraViewpoint(const Esri::ArcGISRuntime::Point &cameraLocation, double heading, double pitch, double roll, Esri::ArcGISRuntime::KmlAltitudeMode altitudeMode)

A static method that returns a KmlViewpoint from the provided camera location.

• cameraLocation - The location of the camera.
• heading - The heading value.
• pitch - The pitch value.
• roll - The roll value.
• altitudeMode - Enumeration of the KML altitude modes.

This function was introduced in Esri::ArcGISRuntime 100.6.

[static, since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::KmlViewpoint KmlViewpoint::createLookAtViewpoint(const Esri::ArcGISRuntime::Point &lookAtLocation, double heading, double pitch, double range, Esri::ArcGISRuntime::KmlAltitudeMode altitudeMode)

A static method that creates a KmlViewpoint from the provided look at location.

• lookAtLocation - The observed location.
• heading - - The heading value.
• pitch - The pitch value.
• range - The range value.
• altitudeMode - Enumeration of the KML altitude modes.

This function was introduced in Esri::ArcGISRuntime 100.6.

[static, since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::KmlViewpoint KmlViewpoint::createWithViewpoint(const Esri::ArcGISRuntime::Viewpoint &viewpoint)

A static method that creates a KML viewpoint from the provided viewpoint.

The viewpoint must have a look at point, and optionally a camera.

This function was introduced in Esri::ArcGISRuntime 100.6.

double KmlViewpoint::heading() const

Returns the KML viewpoint's heading.

Heading is defined in terms of degrees from 0 (North) to 360, with 90 being East.

bool KmlViewpoint::isEmpty() const

Returns true if the object is empty, false otherwise.

Esri::ArcGISRuntime::Point KmlViewpoint::location() const

Returns the KML viewpoint's location. The location associated with this viewpoint, which can be an observed point (LookAt in KML) or the position of a Camera.

double KmlViewpoint::pitch() const

Returns the KML viewpoint's pitch.

Pitch is the angle (in degrees) between the camera and the target location, the angle of the observer's view. Values can range from 0 (straight down) through 90 (looking horizontally) to 180 (straight up toward the sky).

Pitch corresponds to tilt in the KML specification.

Value ranges from 0 and 90 for LookAt viewpoints, 0 and 180 for Camera viewpoints.

double KmlViewpoint::range() const

Returns the KML viewpoint's range.

Range indicates the distance between the camera and the LookAt viewpoint's target location.

double KmlViewpoint::roll() const

Returns the KML viewpoint's roll.

Roll indicates rotation in degrees around the camera's Z axis.

Esri::ArcGISRuntime::KmlViewpointType KmlViewpoint::type() const

Returns the KML viewpoint's type (Camera or LookAt). A KmlViewpointType::Camera viewpoint defines the position of the camera directly. A KmlViewpointType::LookAt viewpoint defines the position of the camera relative to a point of interest. See Google's KML reference for details about KML viewpoint (abstractView) specification, including diagrams.

Esri::ArcGISRuntime::KmlViewpoint &KmlViewpoint::operator=(const Esri::ArcGISRuntime::KmlViewpoint &other)

Assignment operator from other KmlViewpoint.

Esri::ArcGISRuntime::KmlViewpoint &KmlViewpoint::operator=(Esri::ArcGISRuntime::KmlViewpoint &&other)

Move operator from other KmlViewpoint.