.\

cgkml_overlay__define.pro

Graphics, FileIO

This program implements the KML abstract OVERLAY class. For reference, see the Google KML Reference Documentation. An Overlay object is a basic KML class, and should be inherited by, for example, a cgKML_GroundOverlay object, which extends and implements this KML abstract class.

Examples

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

Class description for cgKML_Overlay

Inheritance

cgKML_Feature

All ancestor classes: cgKML_Feature cgKML_Object cgContainer IDL_OBJECT IDL_CONTAINER

Subclasses: cgKML_GroundOverlay cgKML_ScreenOverlay

Properties

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_Overlay

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

Fields

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_Overlay

DRAWORDER 0S
COLOR ''
HREF ''

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, 28 October 2012 by David W. Fanning.

Routines

result = cgKML_Overlay::INIT( [COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, _REF_EXTRA=_REF_EXTRA]): The purpose of this method is to establish an abstract KML Overlay class.
cgKML_Overlay::Body, LUN=integer: This method adds Overlay elements to the KML file.
cgKML_Overlay::Build, LUN=integer: This BUILD method is an abstract method that should be overridden by any object that you intend to add to a KML file.
cgKML_Overlay::GetProperty [, COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, _REF_EXTRA=_REF_EXTRA]: The purpose of this method is to return object properties.
cgKML_Overlay::SetProperty [, COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, _REF_EXTRA=_REF_EXTRA]: The purpose of this method is to set object properties.
cgKML_Overlay::CLEANUP: The purpose of this method is to destroy anything we created that may leak memory or need to be released from use.
cgKML_Overlay__Define [, class]: The cgKML_Overlay class definition module.

Routine details

top cgKML_Overlay::INIT

result = cgKML_Overlay::INIT( [COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, _REF_EXTRA=_REF_EXTRA])

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

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').
_REF_EXTRA in optional: Any keywords appropriate for superclass objects may be passed into the program.

top cgKML_Overlay::Body

cgKML_Overlay::Body, LUN=integer

This method adds Overlay 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_Overlay::Build

cgKML_Overlay::Build, LUN=integer

This BUILD method is an abstract method that should be overridden by any object that you intend to add to a KML file. It is used to build the actual KML code for the element in question.

Keywords

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

top cgKML_Overlay::GetProperty

cgKML_Overlay::GetProperty [, COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, _REF_EXTRA=_REF_EXTRA]

The purpose of this method is to return object properties.

Keywords

COLOR out 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 out 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 out 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').
_REF_EXTRA out optional: Any keywords for the superclass objects are allowed.

top cgKML_Overlay::SetProperty

cgKML_Overlay::SetProperty [, COLOR=string] [, DRAWORDER=integer] [, HREF=string] [, _REF_EXTRA=_REF_EXTRA]

The purpose of this method is to set object properties.

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').
_REF_EXTRA out optional: Any keywords for the superclass objects are allowed.

top cgKML_Overlay::CLEANUP

cgKML_Overlay::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_Overlay__Define

cgKML_Overlay__Define [, class]

The cgKML_Overlay class definition module. This is an abstract class that will be inherited by overlay objects (GroundOverlay, and ScreenOverlay, among others). Basically, any KML element that should be added to a KML file will inherit this object. 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:	279
Docformat:	rst rst

Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

.\

cgkml_overlay__define.pro

Examples

Class description for cgKML_Overlay

Inheritance

Properties

Properties in cgKML_Feature

Properties in cgKML_Object

Properties in cgContainer

Properties in cgKML_Overlay

Fields

Fields in cgKML_Feature

Fields in cgKML_Object

Fields in cgContainer

Fields in IDL_OBJECT

Fields in IDL_CONTAINER

Fields in cgKML_Overlay

Author information

Routines

Routine details

top cgKML_Overlay::INIT

Keywords

top cgKML_Overlay::Body

Keywords

top cgKML_Overlay::Build

Keywords

top cgKML_Overlay::GetProperty

Keywords

top cgKML_Overlay::SetProperty

Keywords

top cgKML_Overlay::CLEANUP

top cgKML_Overlay__Define

Parameters

File attributes