AGSKMLViewpoint Class Reference

Description

KML viewpoint specifying a vantage point for looking at a node.

A KML viewpoint contains information about a viewer's position, either defined as a LookAt relationship to another object or a camera. See the guide documentation and samples for information about converting KML viewpoints into Runtime viewpoints.

Since

100.4

Inheritance diagram for AGSKMLViewpoint:

Class Methods
(AGSKMLViewpoint *)	+ KMLViewpointWithCameraLocation:heading:pitch:roll:altitudeMode:
(AGSKMLViewpoint *)	+ KMLViewpointWithLookAtLocation:heading:pitch:range:altitudeMode:
(AGSKMLViewpoint *)	+ KMLViewpointWithViewpoint:

Properties
AGSKMLAltitudeMode	altitudeMode
double	heading
AGSPoint *	location
double	pitch
double	range
double	roll
AGSKMLViewpointType	type

Method Documentation

KMLViewpointWithCameraLocation:heading:pitch:roll:altitudeMode:

+ (AGSKMLViewpoint *) KMLViewpointWithCameraLocation:		(AGSPoint *)	cameraLocation
heading:		(double)	heading
pitch:		(double)	pitch
roll:		(double)	roll
altitudeMode:		(AGSKMLAltitudeMode)	altitudeMode

Creates a KML viewpoint from the provided camera location. KML viewpoint defines either a standalone camera independent of the point of interest being observed or a virtual camera in relation to the point of interest being observed.

Parameters

cameraLocation	The location of the camera.
heading	The heading of the camera.
pitch	The pitch of the camera.
roll	The roll of the camera.
altitudeMode	The KML altitude mode AGSKMLAltitudeMode.

Returns

An AGSKMLViewpoint.

Since

100.6

KMLViewpointWithLookAtLocation:heading:pitch:range:altitudeMode:

+ (AGSKMLViewpoint *) KMLViewpointWithLookAtLocation:		(AGSPoint *)	lookAtLocation
heading:		(double)	heading
pitch:		(double)	pitch
range:		(double)	range
altitudeMode:		(AGSKMLAltitudeMode)	altitudeMode

Creates a KML viewpoint from the provided look at location. KML viewpoint defines either a standalone camera independent of the point of interest being observed or a virtual camera in relation to the point of interest being observed.

Parameters

lookAtLocation	The observed location.
heading	The heading of the look at point.
pitch	The pitch of the look at point.
range	The distance between the point being observed and the location from where it is being observed.
altitudeMode	The KML altitude mode AGSKMLAltitudeMode.

Returns

An AGSKMLViewpoint.

Since

100.6

KMLViewpointWithViewpoint:

+ (AGSKMLViewpoint *) KMLViewpointWithViewpoint:

(AGSViewpoint *)

viewpoint

Creates a KML viewpoint from a viewpoint. KML viewpoint defines either a look at point or a camera, whereas a viewpoint must always have a look at point, and optionally also have a camera. A viewpoint that has a camera will create a KML viewpoint of type AGSKMLViewpointTypeCamera. A viewpoint that has no camera will create a KML viewpoint of type AGSKMLViewpointTypeLookAt.

Parameters

viewpoint

The viewpoint AGSViewpoint.

Returns

An AGSKMLViewpoint.

Since

100.6

Property Documentation

altitudeMode

- (AGSKMLAltitudeMode) altitudeMode

readnonatomicassign

The altitude mode, which determines how altitude values should be interpreted.

Since

100.4

heading

- (double) heading

readnonatomicassign

The viewpoint's heading in degrees. Ranges from 0 (North) to 360, with 90 being East.

Since

100.4

location

- (AGSPoint*) location

readnonatomicstrong

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.

Since

100.4

pitch

- (double) pitch

readnonatomicassign

The KML viewpoint's pitch is the angle between the camera and the target location. 0 means the camera should point straight down towards the Earth. 90 means the camera is looking from/towards the horizon. Values between 90 and 180 indicate the camera should point towards the sky.

Note

This correspond to the tilt property from the KML specification.

Since

100.4

range

- (double) range

readnonatomicassign

The viewpoint's range is the distance in meters between the location and the camera.

Note

Applies to LookAt viewpoints only.

Since

100.4

roll

- (double) roll

readnonatomicassign

The viewpoint's roll is the rotation of the camera around the Z axis. Values range from -180 to 180 degrees.

Since

100.4

type

- (AGSKMLViewpointType) type

readnonatomicassign

The KML viewpoint's type (AGSKMLViewpointTypeCamera or AGSKMLViewpointTypeLookAt).

An AGSKMLViewpointTypeCamera viewpoint defines the position of the camera directly. An AGSKMLViewpointTypeLookAt 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.

Since

100.4