.\

cgkml_screenoverlay__define.pro

Graphics, FileIO

This program implements the KML ScreenOverlay element. For reference, see the Google KML Reference Documentation. A ScreenOverlay element draws an image onto the Google Earth display or screen.

Examples

See the cgKML_File object for examples of how to create a KML file.

Class description for cgKML_ScreenOverlay

Inheritance

cgKML_Overlay

All ancestor classes: cgKML_Overlay cgKML_Feature cgKML_Object cgContainer IDL_OBJECT IDL_CONTAINER

Properties

Properties in cgKML_Overlay

DRAWORDER get set init
_REF_EXTRA get set init
COLOR get set init
HREF get set init

Properties in cgKML_Feature

STYLEURL get set init
TIMEPRIMITIVE get set init
VISIBILITY get set init
ADDRESS get set init
SNIPPET get set init
PHONENUMBER get set init
ABSTRACTVIEW get set init
OPEN get set init
PLACENAME get set init
_REF_EXTRA get set init
DESCRIPTION get set init
EXTENDEDDATA get set init
AUTHOR get set init

Properties in cgKML_Object

TARGETID get set init
PARENT get set
ID get set
_REF_EXTRA get set init

Properties in cgContainer

UVALUE get set init
NAME get set init
COUNT get
_REF_EXTRA get set

Properties in cgKML_ScreenOverlay

DRAWORDER init
OVERLAY_UNIT_X get set init
OVERLAY_UNIT_Y get set init
SCREEN_XY get set init
ROTATION get set init
SCREEN_UNIT_X get set init
SCREEN_UNIT_Y get set init
_REF_EXTRA get set init
COLOR init
OVERLAY_XY get set init
HREF init
SIZE_UNIT_X get set init
SIZE_UNIT_Y get set init
SIZE_XY get set init

Fields

Fields in cgKML_Overlay

DRAWORDER 0S
COLOR ''
HREF ''

Fields in cgKML_Feature

STYLEURL ''
TIMEPRIMITIVE obj_new()
VISIBILITY 0B
ADDRESS ''
SNIPPET ['', '']
PHONENUMBER ''
ABSTRACTVIEW obj_new()
OPEN 0B
PLACENAME ''
DESCRIPTION ''
EXTENDEDDATA ptr_new()
AUTHOR ptr_new()

Fields in cgKML_Object

TARGETID ''
PARENT obj_new()
ID ''

Fields in cgContainer

_CG_TRASH obj_new()
_CG_NAME ''
_CG_UVALUE ptr_new()

Fields in IDL_OBJECT

IDL_OBJECT_BOTTOM 0LL
__OBJ__ obj_new()
IDL_OBJECT_TOP 0LL

Fields in IDL_CONTAINER

IDLCONTAINERVERSION 0S
IDL_CONTAINER_TOP 0LL
NLIST 0L
PTAIL ptr_new()
PHEAD ptr_new()
IDL_CONTAINER_BOTTOM 0LL

Fields in cgKML_ScreenOverlay

OVERLAY_UNIT_X ''
OVERLAY_UNIT_Y ''
SCREEN_XY [0.00000000D, 0.00000000D]
ROTATION 0.00000000D
SCREEN_UNIT_X ''
SCREEN_UNIT_Y ''
OVERLAY_XY [0.00000000D, 0.00000000D]
SIZE_UNIT_X ''
SIZE_UNIT_Y ''
SIZE_XY [0.00000000D, 0.00000000D]

Author information

Author

FANNING SOFTWARE CONSULTING:

  David W. Fanning
  1645 Sheely Drive
  Fort Collins, CO 80526 USA
  Phone: 970-221-0438
  E-mail: david@idlcoyote.com
  Coyote's Guide to IDL Programming: http://www.idlcoyote.com

Copyright

History

Change History:

  Written, 3 November 2012 by David W. Fanning.

Routines

result = cgKML_ScreenOverlay::INIT( [COLOR=string] [, DRAWORDER=integer] [, HREF=string], OVERLAY_XY=dblarr [, OVERLAY_UNIT_X=string] [, OVERLAY_UNIT_Y=string] [, SCREEN_XY=dblarr] [, SCREEN_UNIT_X=string] [, SCREEN_UNIT_Y=string], SIZE_XY=dblarr [, SIZE_UNIT_X=string] [, SIZE_UNIT_Y=string] [, ROTATION=double] [, _REF_EXTRA=_REF_EXTRA]): The purpose of this method is to establish an abstract KML ScreenOverlay class.
cgKML_ScreenOverlay::Head, LUN=integer: This method opens the <ScreenOverlay> tag in the KML file.
cgKML_ScreenOverlay::Body, LUN=integer: This method adds ScreenOverlay elements to the KML file.
cgKML_ScreenOverlay::Tail, LUN=integer: This method closes the <ScreenOverlay> tag in the KML file.
cgKML_ScreenOverlay::Build, LUN=integer: This BUILD method builds the ScreenOverlay section in the KML file.
cgKML_ScreenOverlay::GetProperty, OVERLAY_XY=dblarr [, OVERLAY_UNIT_X=string] [, OVERLAY_UNIT_Y=string] [, SCREEN_XY=dblarr] [, SCREEN_UNIT_X=string] [, SCREEN_UNIT_Y=string], SIZE_XY=dblarr [, SIZE_UNIT_X=string] [, SIZE_UNIT_Y=string] [, ROTATION=double] [, _REF_EXTRA=_REF_EXTRA]: The purpose of this method is to return object properties.
cgKML_ScreenOverlay::SetProperty, OVERLAY_XY=dblarr [, OVERLAY_UNIT_X=string] [, OVERLAY_UNIT_Y=string] [, SCREEN_XY=dblarr] [, SCREEN_UNIT_X=string] [, SCREEN_UNIT_Y=string], SIZE_XY=dblarr [, SIZE_UNIT_X=string] [, SIZE_UNIT_Y=string] [, ROTATION=double] [, _REF_EXTRA=_REF_EXTRA]: The purpose of this method is to set object properties.
cgKML_ScreenOverlay::CLEANUP: The purpose of this method is to destroy anything we created that may leak memory or need to be released from use.
cgKML_ScreenOverlay__Define [, class]: The cgKML_ScreenOverlay class definition module.

Routine details

top cgKML_ScreenOverlay::INIT

result = cgKML_ScreenOverlay::INIT( [COLOR=string] [, DRAWORDER=integer] [, HREF=string], OVERLAY_XY=dblarr [, OVERLAY_UNIT_X=string] [, OVERLAY_UNIT_Y=string] [, SCREEN_XY=dblarr] [, SCREEN_UNIT_X=string] [, SCREEN_UNIT_Y=string], SIZE_XY=dblarr [, SIZE_UNIT_X=string] [, SIZE_UNIT_Y=string] [, ROTATION=double] [, _REF_EXTRA=_REF_EXTRA])

The purpose of this method is to establish an abstract KML ScreenOverlay class. For reference, see https://developers.google.com/kml/documentation/kmlreference?hl=fr#ScreenOverlay.

Keywords

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').
OVERLAY_XY in required type=dblarr: This keyword specifies a point [x,y] in the image overlay that is mapped to the screen coordinate Screen_XY. The location of the point is specified by the values in Overlay_Units_X and 'Overlay_Units_Y.
OVERLAY_UNIT_X in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
OVERLAY_UNIT_Y in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
SCREEN_XY in optional type=dblarr: This keyword specifies a point [x,y] relative to the screen origin that the overlay image is mapped to. The location of the point is specified by the values in XUnits and 'YUnits.
SCREEN_UNIT_X in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
SCREEN_UNIT_Y in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
SIZE_XY in required type=dblarr: This keyword specifies the size of the image for the screen overlay as follows. A -1 indicates to use the native dimensions of the image. A 0 indicates that the aspect ratio of the image should be preserved. Any other value sets the output dimension of the image, according to the "unit" values.
SIZE_UNIT_X in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
SIZE_UNIT_Y in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
ROTATION in optional type=double default=0.0: This keyword indicates the angle of rotation of the screen overlay in degrees counterclockwise from North. A value from -180 to 180.
_REF_EXTRA in optional: Any keywords appropriate for superclass objects may be passed into the program.

top cgKML_ScreenOverlay::Head

cgKML_ScreenOverlay::Head, LUN=integer

This method opens the <ScreenOverlay> tag in the KML file.

Keywords

LUN in required type=integer: The logical unit number of the open KML file to write to.

top cgKML_ScreenOverlay::Body

cgKML_ScreenOverlay::Body, LUN=integer

This method adds ScreenOverlay elements to the KML file.

Keywords

LUN in required type=integer: The logical unit number of the open KML file to write to.

top cgKML_ScreenOverlay::Tail

cgKML_ScreenOverlay::Tail, LUN=integer

This method closes the <ScreenOverlay> tag in the KML file.

Keywords

LUN in required type=integer: The logical unit number of the open KML file to write to.

top cgKML_ScreenOverlay::Build

cgKML_ScreenOverlay::Build, LUN=integer

This BUILD method builds the ScreenOverlay section in the KML file.

Keywords

LUN in required type=integer: The logical unit number of the open KML file to write to.

top cgKML_ScreenOverlay::GetProperty

cgKML_ScreenOverlay::GetProperty, OVERLAY_XY=dblarr [, OVERLAY_UNIT_X=string] [, OVERLAY_UNIT_Y=string] [, SCREEN_XY=dblarr] [, SCREEN_UNIT_X=string] [, SCREEN_UNIT_Y=string], SIZE_XY=dblarr [, SIZE_UNIT_X=string] [, SIZE_UNIT_Y=string] [, ROTATION=double] [, _REF_EXTRA=_REF_EXTRA]

The purpose of this method is to return object properties.

Keywords

OVERLAY_XY out required type=dblarr: This keyword specifies a point [x,y] in the image overlay that is mapped to the screen coordinate Screen_XY. The location of the point is specified by the values in Overlay_Units_X and 'Overlay_Units_Y.
OVERLAY_UNIT_X out optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
OVERLAY_UNIT_Y out optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
SCREEN_XY out optional type=dblarr: This keyword specifies a point [x,y] relative to the screen origin that the overlay image is mapped to. The location of the point is specified by the values in XUnits and 'YUnits.
SCREEN_UNIT_X out optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
SCREEN_UNIT_Y out optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
SIZE_XY out required type=dblarr: This keyword specifies the size of the image for the screen overlay as follows. A -1 indicates to use the native dimensions of the image. A 0 indicates that the aspect ratio of the image should be preserved. Any other value sets the output dimension of the image, according to the "unit" values.
SIZE_UNIT_X out optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
SIZE_UNIT_Y out optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
ROTATION out optional type=double default=0.0: This keyword indicates the angle of rotation of the screen overlay in degrees counterclockwise from North. A value from -180 to 180.
_REF_EXTRA out optional: Any keywords for the superclass objects are allowed.

top cgKML_ScreenOverlay::SetProperty

cgKML_ScreenOverlay::SetProperty, OVERLAY_XY=dblarr [, OVERLAY_UNIT_X=string] [, OVERLAY_UNIT_Y=string] [, SCREEN_XY=dblarr] [, SCREEN_UNIT_X=string] [, SCREEN_UNIT_Y=string], SIZE_XY=dblarr [, SIZE_UNIT_X=string] [, SIZE_UNIT_Y=string] [, ROTATION=double] [, _REF_EXTRA=_REF_EXTRA]

The purpose of this method is to set object properties.

Keywords

OVERLAY_XY in required type=dblarr: This keyword specifies a point [x,y] in the image overlay that is mapped to the screen coordinate Screen_XY. The location of the point is specified by the values in Overlay_Units_X and 'Overlay_Units_Y.
OVERLAY_UNIT_X in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
OVERLAY_UNIT_Y in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
SCREEN_XY in optional type=dblarr: This keyword specifies a point [x,y] relative to the screen origin that the overlay image is mapped to. The location of the point is specified by the values in XUnits and 'YUnits.
SCREEN_UNIT_X in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
SCREEN_UNIT_Y in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
SIZE_XY in required type=dblarr: This keyword specifies the size of the image for the screen overlay as follows. A -1 indicates to use the native dimensions of the image. A 0 indicates that the aspect ratio of the image should be preserved. Any other value sets the output dimension of the image, according to the "unit" values.
SIZE_UNIT_X in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the X value is a fraction of the image; (2) "pixels" indicates the the X value is in pixels; and (3) "insetPixels" indicates the X value is an indent from the right edge of the image.
SIZE_UNIT_Y in optional type=string default=fraction: Three values are possible: (1) "fraction" indicates that the Y value is a fraction of the image; (2) "pixels" indicates the the Y value is in pixels; and (3) "insetPixels" indicates the Y value is an indent from the top edge of the image.
ROTATION in optional type=double default=0.0: This keyword indicates the angle of rotation of the screen overlay in degrees counterclockwise from North. A value from -180 to 180.
_REF_EXTRA out optional: Any keywords for the superclass objects are allowed.

top cgKML_ScreenOverlay::CLEANUP

cgKML_ScreenOverlay::CLEANUP

The purpose of this method is to destroy anything we created that may leak memory or need to be released from use.

top cgKML_ScreenOverlay__Define

cgKML_ScreenOverlay__Define [, class]

The cgKML_ScreenOverlay class definition module. It is a container object and represents part of the KML file hierarchy.

Parameters

class out optional type=structure: The class definition returned as a structure variable. Occassionally useful.

File attributes

Modification date:	Fri Mar 27 11:07:38 2015
Lines:	524
Docformat:	rst rst

Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

.\

cgkml_screenoverlay__define.pro

Examples

Class description for cgKML_ScreenOverlay

Inheritance

Properties

Properties in cgKML_Overlay

Properties in cgKML_Feature

Properties in cgKML_Object

Properties in cgContainer

Properties in cgKML_ScreenOverlay

Fields

Fields in cgKML_Overlay

Fields in cgKML_Feature

Fields in cgKML_Object

Fields in cgContainer

Fields in IDL_OBJECT

Fields in IDL_CONTAINER

Fields in cgKML_ScreenOverlay

Author information

Routines

Routine details

top cgKML_ScreenOverlay::INIT

Keywords

top cgKML_ScreenOverlay::Head

Keywords

top cgKML_ScreenOverlay::Body

Keywords

top cgKML_ScreenOverlay::Tail

Keywords

top cgKML_ScreenOverlay::Build

Keywords

top cgKML_ScreenOverlay::GetProperty

Keywords

top cgKML_ScreenOverlay::SetProperty

Keywords

top cgKML_ScreenOverlay::CLEANUP

top cgKML_ScreenOverlay__Define

Parameters

File attributes