Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

Overview Directory File Etc Categories Search Index Warnings Help Developer documentation

single page | use frames     summary     class     fields     routine details     file attributes

.\

cgkml_lookat__define.pro

Graphics, FileIO


This program implements the KML abstract LookAt class. For reference, see the Google KML Reference Documentation. A LookAt object extends a KML Object. The purpose of this object is to allow Google Earth to "fly to" a particular location.

Examples

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

Class description for cgKML_LookAt

Inheritance

All ancestor classes: cgKML_Object cgContainer IDL_OBJECT IDL_CONTAINER

Properties

Properties in cgKML_Object

Properties in cgContainer

Properties in cgKML_LookAt

LATITUDE get set init
LONGITUDE get set init
HEIGHT get set init
ALTITUDEMODE get set init
TILT get set init
_REF_EXTRA get set init
HEADING get set init

Fields

Fields in cgKML_Object

Fields in cgContainer

Fields in IDL_OBJECT

Fields in IDL_CONTAINER

Fields in cgKML_LookAt

LATITUDE 0.000000
ALTITUDE 0.00000000D
LONGITUDE 0.000000
RANGE 0.00000000D
ALTITUDEMODE ''
TILT 0.000000
HEADING 0.000000

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

Copyright (c) 2012, Fanning Software Consulting, Inc.

History

Change History:

Written, 31 December 2012 by David W. Fanning.

Routines

result = cgKML_LookAt::INIT( [ALTITUDEMODE=string] [, HEADING=float] [, HEIGHT=double] [, LATITUDE=float] [, LONGITUDE=float] [, TILT=float], _REF_EXTRA=_REF_EXTRA)

The purpose of this method is to establish a KML LookAt object class.

cgKML_LookAt::Build, LUN=integer

This method builds the feature in a KML file.

cgKML_LookAt::Body, LUN=integer

This method adds LookAt elements to the KML file.

cgKML_LookAt::Head, LUN=integer

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

cgKML_LookAt::Tail, LUN=integer

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

cgKML_LookAt::GetProperty [, ALTITUDEMODE=string] [, HEADING=float] [, HEIGHT=double] [, LATITUDE=float] [, LONGITUDE=float] [, TILT=float], _REF_EXTRA=_REF_EXTRA

The purpose of this method is to set the object's properties.

cgKML_LookAt::SetProperty [, ALTITUDEMODE=string] [, HEADING=float] [, HEIGHT=double] [, LATITUDE=float] [, LONGITUDE=float] [, TILT=float], _REF_EXTRA=_REF_EXTRA

The purpose of this method is to set the object's properties.

cgKML_LookAt::CLEANUP

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

cgKML_LookAt__Define [, class]

The cgKML_LookAt class definition module.

Routine details

top cgKML_LookAt::INIT

result = cgKML_LookAt::INIT( [ALTITUDEMODE=string] [, HEADING=float] [, HEIGHT=double] [, LATITUDE=float] [, LONGITUDE=float] [, TILT=float], _REF_EXTRA=_REF_EXTRA)

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

Keywords

ALTITUDEMODE in optional type=string default=relativeToGround

The mode of the altitude. Possible values are: "clampToGround", "relativeToGround" and "absolute".

HEADING in optional type=float default=0.0

The angle of the view. Valid values 0 to 360.

HEIGHT in optional type=double default=11000.0

The altitude (in km) of the eye with respect to the lat/lon point of the eye. Called "altitude" in the KML documentation, but called "height" here to differentiate keyword from "altitudeMode". Positive values in kilometers.

LATITUDE in optional type=float default=0.0

The input latitude where the eye should be located. Valid values -90 to 90.

LONGITUDE in optional type=float default=0.0

The input longitude where the eye should be located. Valid values -180 to 180.

TILT in optional type=float default=0.0

The tilt angle of the eye. Valid values 0 to 90. _ref_extra: in, optional Any keywords appropriate for superclass objects may be passed into the program.

_REF_EXTRA

top cgKML_LookAt::Build

cgKML_LookAt::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_LookAt::Body

cgKML_LookAt::Body, LUN=integer

This method adds LookAt 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_LookAt::Head

cgKML_LookAt::Head, LUN=integer

This method opens the <LookAt> 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_LookAt::Tail

cgKML_LookAt::Tail, LUN=integer

This method closes the <LookAt> 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_LookAt::GetProperty

cgKML_LookAt::GetProperty [, ALTITUDEMODE=string] [, HEADING=float] [, HEIGHT=double] [, LATITUDE=float] [, LONGITUDE=float] [, TILT=float], _REF_EXTRA=_REF_EXTRA

The purpose of this method is to set the object's properties.

Keywords

ALTITUDEMODE out optional type=string

The mode of the altitude. Possible values are: "clampToGround", "relativeToGround" and "absolute".

HEADING out optional type=float

The angle of the view. Valid values 0 to 360.

HEIGHT out optional type=double

The altitude (in km) of the eye with respect to the lat/lon point of the eye. Called "altitude" in the KML documentation, but called "height" here to differentiate keyword from "altitudeMode".

LATITUDE out optional type=float

The input latitude where the eye should be located. Valid values -90 to 90.

LONGITUDE out optional type=float

The input longitude where the eye should be located.

TILT out optional type=float

The tilt angle of the eye. Valid values 0 to 90. _ref_extra: out, optional Any keywords appropriate for superclass objects may be passed into the program.

_REF_EXTRA

top cgKML_LookAt::SetProperty

cgKML_LookAt::SetProperty [, ALTITUDEMODE=string] [, HEADING=float] [, HEIGHT=double] [, LATITUDE=float] [, LONGITUDE=float] [, TILT=float], _REF_EXTRA=_REF_EXTRA

The purpose of this method is to set the object's properties.

Keywords

ALTITUDEMODE in optional type=string default=relativeToGround

The mode of the altitude. Possible values are: "clampToGround", "relativeToGround" and "absolute".

HEADING in optional type=float default=0.0

The angle of the view. Valid values 0 to 360.

HEIGHT in optional type=double default=500.0

The altitude (in km) of the eye with respect to the lat/lon point of the eye. Called "altitude" in the KML documentation, but called "height" here to differentiate keyword from "altitudeMode". Positive values in kilometers.

LATITUDE in optional type=float default=0.0

The input latitude where the eye should be located. Valid values -90 to 90.

LONGITUDE in optional type=float default=0.0

The input longitude where the eye should be located. Valid values -180 to 180.

TILT in optional type=float default=0.0

The tilt angle of the eye. Valid values 0 to 90. _ref_extra: in, optional Any keywords appropriate for superclass objects may be passed into the program.

_REF_EXTRA

top cgKML_LookAt::CLEANUP

cgKML_LookAt::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_LookAt__Define

cgKML_LookAt__Define [, class]

The cgKML_LookAt class definition module. This is a class that allows the Google Earth application to "fly to" the position indicated.

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: 400
Docformat: rst rst
Produced by IDLdoc 3.5.0 on Fri Mar 27 12:14:59 2015 IDLdoc project information