top cgKML_GroundOverlay::INIT

result = cgKML_GroundOverlay::INIT( [ALTITUDE=double] [, ALTMODE=string] [, COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, LATLONBOX=fltarr] [, LATLONQUAD=fltarr] [, ROTATION=float] [, _REF_EXTRA=_REF_EXTRA])

Keywords

ALTITUDE in optional type=double

Specifies the distance above the earth's surface, in meters, and is interpreted according to the altitude mode

ALTMODE in optional type=string default=clampToGround

The altitude mode. Possible values are "clampToGround", which ignores the Altitude value and drapes the overlay over the terrain. The other possible mode is "absolute", which sets the altitude of the overlay relative to sea level, regardless of the actual elevation of the terrain beneath the element. For example, if you set the altitude of an overlay to 10 meters with an absolute altitude mode, the overlay will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the overlay will appear elevated above the terrain by 7 meters. It is also possible to set the mode to "clampToSeaFloor".

COLOR in optional type=string

Color values are expressed in hexadecimal notation, including opacity (alpha) values. The order of expression is alpha, blue, green, red (aabbggrr). The range of values for any one color is 0 to 255 (00 to ff). For opacity, 00 is fully transparent and ff is fully opaque. For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: COLOR = "7fff0000".

DRAWORDER in optional type=integer

This element defines the stacking order for the images in overlapping overlays. Overlays with higher values are drawn on top of overlays with lower values.

HREF in optional type=string

A URL that identifies the location of the image associated with this Overlay. The location can be either a local file (e.g., 'myimage.png') or a URL to an image on a web server (e.g., 'http://www.idlcoyote.com/images/myimage.png').

LATLONBOX in optional type=fltarr

A four-element float array that specifies the top, bottom, right, and left sides of a bounding box that the ground overlay is aligned to. The elements of the array also correspond to [north, south, east, west] coordinates, which should be specified in decimal degrees. North/South coordinates are in the range -90 to +90, and East/West coordinates are in the range -180 to 180.

LATLONQUAD in optional type=fltarr

An 8-element array describing the four corners of a quadrilateral defining the overlay area. Exactly four coordinate pairs have to be provided, each consisting of floating point values for longitude and latitude. The coordinates must be specified in counter-clockwise order with the first coordinate corresponding to the lower-left corner of the overlayed image. The shape described by these corners must be convex.

ROTATION in optional type=float default=0.0

Specifies a rotation of the overlay about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction. Used only with the LatLonBox array.

_REF_EXTRA in optional

Any keywords appropriate for superclass objects may be passed into the program.

top cgKML_GroundOverlay::Head

cgKML_GroundOverlay::Head, LUN=integer

Keywords

LUN in required type=integer

The logical unit number of the open KML file to write to.

top cgKML_GroundOverlay::Body

cgKML_GroundOverlay::Body, LUN=integer

Keywords

LUN in required type=integer

The logical unit number of the open KML file to write to.

top cgKML_GroundOverlay::Tail

cgKML_GroundOverlay::Tail, LUN=integer

Keywords

LUN in required type=integer

The logical unit number of the open KML file to write to.

top cgKML_GroundOverlay::Build

cgKML_GroundOverlay::Build, LUN=integer

Keywords

LUN in required type=integer

The logical unit number of the open KML file to write to.

top cgKML_GroundOverlay::GetProperty

cgKML_GroundOverlay::GetProperty [, ALTITUDE=double] [, ALTMODE=string] [, LATLONBOX=fltarr] [, LATLONQUAD=fltarr] [, ROTATION=float] [, _REF_EXTRA=_REF_EXTRA]

Keywords

ALTITUDE out optional type=double

Specifies the distance above the earth's surface, in meters, and is interpreted according to the altitude mode

ALTMODE out optional type=string default=clampToGround

The altitude mode. Possible values are "clampToGround", which ignores the Altitude value and drapes the overlay over the terrain. The other possible mode is "absolute", which sets the altitude of the overlay relative to sea level, regardless of the actual elevation of the terrain beneath the element. For example, if you set the altitude of an overlay to 10 meters with an absolute altitude mode, the overlay will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the overlay will appear elevated above the terrain by 7 meters.

LATLONBOX out optional type=fltarr

A four-element float array that specifies the top, bottom, right, and left sides of a bounding box that the ground overlay is aligned to. The elements of the array also correspond to [north, south, east, west] coordinates, which should be specified in decimal degrees. North/South coordinates are in the range -90 to +90, and East/West coordinates are in the range -180 to 180.

LATLONQUAD out optional type=fltarr

An 8-element array describing the four corners of a quadrilateral defining the overlay area. Exactly four coordinate pairs have to be provided, each consisting of floating point values for longitude and latitude. The coordinates must be specified in counter-clockwise order with the first coordinate corresponding to the lower-left corner of the overlayed image. The shape described by these corners must be convex.

ROTATION out optional type=float default=0.0

Specifies a rotation of the overlay about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction. Used only with the LatLonBox array.

_REF_EXTRA out optional

Any keywords for the superclass objects are allowed.

top cgKML_GroundOverlay::SetProperty

cgKML_GroundOverlay::SetProperty [, ALTITUDE=double] [, ALTMODE=string] [, LATLONBOX=fltarr] [, LATLONQUAD=fltarr] [, ROTATION=float] [, _REF_EXTRA=_REF_EXTRA]

Keywords

ALTITUDE in optional type=double

Specifies the distance above the earth's surface, in meters, and is interpreted according to the altitude mode

ALTMODE in optional type=string default=clampToGround

The altitude mode. Possible values are "clampToGround", which ignores the Altitude value and drapes the overlay over the terrain. The other possible mode is "absolute", which sets the altitude of the overlay relative to sea level, regardless of the actual elevation of the terrain beneath the element. For example, if you set the altitude of an overlay to 10 meters with an absolute altitude mode, the overlay will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the overlay will appear elevated above the terrain by 7 meters.

LATLONBOX in optional type=fltarr

A four-element float array that specifies the top, bottom, right, and left sides of a bounding box that the ground overlay is aligned to. The elements of the array also correspond to [north, south, east, west] coordinates, which should be specified in decimal degrees. North/South coordinates are in the range -90 to +90, and East/West coordinates are in the range -180 to 180.

LATLONQUAD in optional type=fltarr

An 8-element array describing the four corners of a quadrilateral defining the overlay area. Exactly four coordinate pairs have to be provided, each consisting of floating point values for longitude and latitude. The coordinates must be specified in counter-clockwise order with the first coordinate corresponding to the lower-left corner of the overlayed image. The shape described by these corners must be convex.

ROTATION in optional type=float default=0.0

Specifies a rotation of the overlay about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction. Used only with the LatLonBox array.

_REF_EXTRA out optional

Any keywords for the superclass objects are allowed.

top cgKML_GroundOverlay::CLEANUP

cgKML_GroundOverlay::CLEANUP

top cgKML_GroundOverlay__Define

cgKML_GroundOverlay__Define [, class]

Parameters

class out optional type=structure

The class definition returned as a structure variable. Occassionally useful.