.\

cgkml_feature__define.pro

Graphics, FileIO

This program implements the KML abstract FEATURE class. For reference, see the Google KML Reference Documentation. A Feature object extends a KML Object, and both should be inherited by, for example, a KML Overlay object, which further extends this KML abstract class.

Examples

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

Class description for cgKML_Feature

Inheritance

cgKML_Object

All ancestor classes: cgKML_Object cgContainer IDL_OBJECT IDL_CONTAINER

Subclasses: cgKML_Overlay

Properties

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_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

Fields

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_Feature

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

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.
  Fixed typo in spelling of N_Elements. 16 Jan 2013. DWF.

Routines

result = cgKML_Feature::INIT( [ABSTRACTVIEW=object] [, ADDRESS=string] [, AUTHOR=struct] [, DESCRIPTION=string] [, EXTENDEDDATA=structure] [, /OPEN] [, PHONENUMBER=string] [, PLACENAME=string] [, SNIPPET=string] [, STYLEURL=string] [, TIMEPRIMITIVE=object] [, /VISIBILITY], _REF_EXTRA=_REF_EXTRA): The purpose of this method is to establish a KML Feature object class.
cgKML_Feature::Body, LUN=integer: This method adds Feature elements to the KML file.
cgKML_Feature::Build, LUN=integer: This method builds the feature in a KML file.
cgKML_Feature::GetProperty [, ABSTRACTVIEW=object] [, ADDRESS=string] [, AUTHOR=struct] [, DESCRIPTION=string] [, EXTENDEDDATA=structure] [, /OPEN] [, PLACENAME=string] [, PHONENUMBER=string] [, SNIPPET=string] [, STYLEURL=string] [, TIMEPRIMITIVE=object] [, /VISIBILITY], _REF_EXTRA=_REF_EXTRA: The purpose of this method is to return object properties.
cgKML_Feature::SetProperty [, ABSTRACTVIEW=object] [, ADDRESS=string] [, AUTHOR=struct] [, DESCRIPTION=string] [, EXTENDEDDATA=structure] [, /OPEN] [, PHONENUMBER=string] [, PLACENAME=string] [, SNIPPET=string] [, STYLEURL=string] [, TIMEPRIMITIVE=object] [, /VISIBILITY], _REF_EXTRA=_REF_EXTRA: The purpose of this method is to set object properties.
cgKML_Feature::CLEANUP: The purpose of this method is to destroy anything we created that may leak memory or need to be released from use.
cgKML_Feature__Define [, class]: The cgKML_Feature class definition module.

Routine details

top cgKML_Feature::INIT

result = cgKML_Feature::INIT( [ABSTRACTVIEW=object] [, ADDRESS=string] [, AUTHOR=struct] [, DESCRIPTION=string] [, EXTENDEDDATA=structure] [, /OPEN] [, PHONENUMBER=string] [, PLACENAME=string] [, SNIPPET=string] [, STYLEURL=string] [, TIMEPRIMITIVE=object] [, /VISIBILITY], _REF_EXTRA=_REF_EXTRA)

The purpose of this method is to establish a KML Feature object class. For reference, see https://developers.google.com/kml/documentation/kmlreference#feature.

Keywords

ABSTRACTVIEW in optional type=object: Defines a viewpoint associated with any element derived from Feature. Either a cgKML_Camera or cgKML_LookAt object.
ADDRESS in optional type=string: A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the <address> tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a <Point> is provided, it takes precedence over the <address>.)
AUTHOR in optional type=struct: An anonymous structure with two tags. Tag "NAME" is a string that gives the author's name, and tag "LINK" is a string that provides a URL to the author's web site.
DESCRIPTION in optional type=string: User-supplied content that appears in the description balloon. Can be complicated. See the KML Reference for "Feature", cited above.
EXTENDEDDATA in optional type=structure: A scalar or vector of anonymous structures containing a tag NAME and a tag VALUE, which are both strings. An optional third field DISPLAYNAME can also be present. See the <ExtendedData> reference (https://developers.google.com/kml/documentation/kmlreference#extendeddata) for additional information.
OPEN in optional type=boolean default=0: This keyword specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. The default is to show the Document or Folder collapsed rather than expanded.
PHONENUMBER in optional type=string: A phone number. Used only by Google Maps Mobile.
PLACENAME in optional type=string: This is the <name> element in a Feature object. It is user-defined text that is used as the label for an object in Google Earth.
SNIPPET in optional type=string: A short description of the feature. This description is displayed in the Places panel under the name of the feature. If not supplied, the first two lines of the Description are used.
STYLEURL in optional type=string: The URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing.
TIMEPRIMITIVE in optional type=object: Associates this feature with a period of time (cgKML_Timespan object) or a point in time (KML_Timestamp object).
VISIBILITY in optional type=boolean default=1: This keyword specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the <visibility> tag of all its ancestors must also be set to 1. In the Google Earth List View, each Feature has a checkbox that allows the user to control visibility of the Feature. _ref_extra: in, optional Any keywords appropriate for superclass objects may be passed into the program.
_REF_EXTRA

top cgKML_Feature::Body

cgKML_Feature::Body, LUN=integer

This method adds Feature 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_Feature::Build

cgKML_Feature::Build, LUN=integer

This method builds the feature in a KML file.

Keywords

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

top cgKML_Feature::GetProperty

cgKML_Feature::GetProperty [, ABSTRACTVIEW=object] [, ADDRESS=string] [, AUTHOR=struct] [, DESCRIPTION=string] [, EXTENDEDDATA=structure] [, /OPEN] [, PLACENAME=string] [, PHONENUMBER=string] [, SNIPPET=string] [, STYLEURL=string] [, TIMEPRIMITIVE=object] [, /VISIBILITY], _REF_EXTRA=_REF_EXTRA

The purpose of this method is to return object properties.

Keywords

ABSTRACTVIEW out optional type=object: Defines a viewpoint associated with any element derived from Feature. Either a cgKML_Camera or cgKML_LookAt object.
ADDRESS out optional type=string: A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the <address> tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a <Point> is provided, it takes precedence over the <address>.)
AUTHOR out optional type=struct: An anonymous structure with two tags. Tag "NAME" is a string that gives the author's name, and tag "LINK" is a string that provides a URL to the author's web site.
DESCRIPTION out optional type=string: User-sullied content that appears in the description balloon. Can be complicated. See the KML Reference for "Feature", cited above.
EXTENDEDDATA out optional type=structure: A scalar or vector of anonymous structures containing a tag NAME and a tag VALUE, which are both strings. An optional third field DISPLAYNAME can also be present. See the <ExtendedData> reference (https://developers.google.com/kml/documentation/kmlreference#extendeddata) for additional information.
OPEN out optional type=boolean default=0: This keyword specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. The default is to show the Document or Folder collapsed rather than expanded.
PLACENAME out optional type=string: This is the <name> element in a Feature object. It is user-defined text that is used as the label for an object in Google Earth.
PHONENUMBER out optional type=string: A phone number. Used only by Google Maps Mobile.
SNIPPET in optional type=string: A short description of the feature. This description is displayed in the Places panel under the name of the feature. If not supplied, the first two lines of the Description are used.
STYLEURL out optional type=string: The URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing.
TIMEPRIMITIVE out optional type=object: Associates this feature with a period of time (cgKML_Timespan object) or a point in time (KML_Timestamp object).
VISIBILITY out optional type=boolean default=1: This keyword specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the <visibility> tag of all its ancestors must also be set to 1. In the Google Earth List View, each Feature has a checkbox that allows the user to control visibility of the Feature. _ref_extra: out, optional Any keywords appropriate for superclass objects may be passed into the program.
_REF_EXTRA

top cgKML_Feature::SetProperty

cgKML_Feature::SetProperty [, ABSTRACTVIEW=object] [, ADDRESS=string] [, AUTHOR=struct] [, DESCRIPTION=string] [, EXTENDEDDATA=structure] [, /OPEN] [, PHONENUMBER=string] [, PLACENAME=string] [, SNIPPET=string] [, STYLEURL=string] [, TIMEPRIMITIVE=object] [, /VISIBILITY], _REF_EXTRA=_REF_EXTRA

The purpose of this method is to set object properties.

Keywords

ABSTRACTVIEW in optional type=object: Defines a viewpoint associated with any element derived from Feature. Either a cgKML_Camera or cgKML_LookAt object.
ADDRESS in optional type=string: A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the <address> tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a <Point> is provided, it takes precedence over the <address>.)
AUTHOR in optional type=struct: An anonymous structure with two tags. Tag "NAME" is a string that gives the author's name, and tag "LINK" is a string that provides a URL to the author's web site.
DESCRIPTION in optional type=string: User-sullied content that appears in the description balloon. Can be complicated. See the KML Reference for "Feature", cited above.
EXTENDEDDATA in optional type=structure: A scalar or vector of anonymous structures containing a tag NAME and a tag VALUE, which are both strings. An optional third field DISPLAYNAME can also be present. See the <ExtendedData> reference (https://developers.google.com/kml/documentation/kmlreference#extendeddata) for additional information.
OPEN in optional type=boolean default=0: This keyword specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. The default is to show the Document or Folder collapsed rather than expanded.
PHONENUMBER in optional type=string: A phone number. Used only by Google Maps Mobile.
PLACENAME in optional type=string: This is the <name> element in a Feature object. It is user-defined text that is used as the label for an object in Google Earth.
SNIPPET in optional type=string: A short description of the feature. This description is displayed in the Places panel under the name of the feature. If not supplied, the first two lines of the Description are used.
STYLEURL in optional type=string: The URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing.
TIMEPRIMITIVE in optional type=object: Associates this feature with a period of time (cgKML_Timespan object) or a point in time (KML_Timestamp object).
VISIBILITY in optional type=boolean default=1: This keyword specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the <visibility> tag of all its ancestors must also be set to 1. In the Google Earth List View, each Feature has a checkbox that allows the user to control visibility of the Feature. _ref_extra: in, optional Any keywords appropriate for superclass objects may be passed into the program.
_REF_EXTRA

top cgKML_Feature::CLEANUP

cgKML_Feature::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_Feature__Define

cgKML_Feature__Define [, class]

The cgKML_Feature class definition module. This is a mostly abstract class that will be inherited by cgKML_Overlay and cgKML_Container objects (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:41 2015
Lines:	495
Docformat:	rst rst

Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

.\

cgkml_feature__define.pro

Examples

Class description for cgKML_Feature

Inheritance

Properties

Properties in cgKML_Object

Properties in cgContainer

Properties in cgKML_Feature

Fields

Fields in cgKML_Object

Fields in cgContainer

Fields in IDL_OBJECT

Fields in IDL_CONTAINER

Fields in cgKML_Feature

Author information

Routines

Routine details

top cgKML_Feature::INIT

Keywords

top cgKML_Feature::Body

Keywords

top cgKML_Feature::Build

Keywords

top cgKML_Feature::GetProperty

Keywords

top cgKML_Feature::SetProperty

Keywords

top cgKML_Feature::CLEANUP

top cgKML_Feature__Define

Parameters

File attributes