Description | Example | Return Message | Group

VO_RM KML

Return information about KML documents in a 3D window

Syntax

VO_RM <ScenarioPath> KML {KMLOption} [{Parameters}] [WindowID <WinNumber>]

Related Commands

Description

The VO_RM KML command allows you to obtain information about the KML documents currently loaded in the 3D window.

All VO_RM KML commands can optionally include the WindowID <WinNumber> parameter. If not included, the command will be applied to the first 3d Window.

The following table describes the {KMLOption} and {Parameters}.

{KMLOption} {Parameters} Description
Files N/A Return the file names, if applicable, for all kml documents loaded in the 3d window.

If a document has no file name, then [NoFileName] will be returned.
Documents N/A Return the document names, if applicable, for all kml documents loaded in the 3d window.

If a document has no name, then [NoDocumentName] will be returned.
Features {File "<FilePath>" | Document "<DocName>"} [Delimiter <c>] Return the feature names of the specified File name or Document name.

Optionally, enter a single character to be used as the delimiter between levels of the Feature Name. The default delimiter is the forward slash, "/".

If a Feature level has no name, then a single space will be returned for that level.

Features and Delimiter

The Feature name will be returned exactly as it appears in the kml file. If the Feature has multiple levels, each level in the hierarchy path will be separated by a delimiter. The default delimiter is the forward slash "/" (e.g. World/Countries/US) but the user may specify a unique character for the delimiter by using the Delimiter parameter.

Note: The Delimiter can not be a double quote ("), or the backslash (\).

If a Feature level has no name, then a single space, between the delimiters, will be returned for that level. For example, the following feature has no name for the second level.

Ionops/ /ColorKey

If a Feature name contains a double quote ("), a backslash (\) or the Delimiter, then the double quote, backslash or delimiter character will be preceded by a backslash (\).

If a Feature name contains a newline, tab or other whitespace character, the following character representation will be used. For newline "\n"; for horizontal tab "\t"; for vertical tab "\v"; for formfeed "\f".

Example

Examples of returned feature names:

The Feature name contains the double quote: Glacier, Ice Shelf "Velocity"

Glacier/Ice Shelf \"Velocity\"

The Feature name contains the delimiter (/): Glacier, Ice Shelf/Velocity

Glacier/Ice Shelf\/Velocity

The Feature name contains a tab: Glacier, Ice Shelf(tab)Velocity

Glacier/Ice Shelf\tVelocity

Example

Return the document names of KML documents loaded in 3d Window 2:

VO_RM * KML Documents

Return the file names of loaded KML documents:

VO_RM * KML Files WindowID 2

ReturnMessage

Connect returns a list of KML Filenames loaded in 3D Window 2:
ACK
C:\Users\Test\Documents\kml\kmlsamples.kml
C:\Users\Test\Documents\kml\real_pa.kml

Example

Return the Feature names of KML Samples document, using the default delimiter:

VO_RM * KML Features Document "KML Samples"

ReturnMessage

Connect returns a list of features for the document "KML Samples":
ACK
Placemark
Placemark/Simple Placemark
Placemark/Floating Placemark
Ground Overlays
Ground Overlays/0 Rotation - Image
Ground Overlays/0 Rotation - Color
...

Example

Return the Feature names of KML Samples, with a semi-colon delimiter between levels:

VO_RM * KML Features File "C:\Users\Test\Documents\kml\kmlsamples.kml" Delimiter ;

ReturnMessage

Connect returns a list of features for the document "KML Samples", using the semi-colon as a delimiter:
ACK
Placemark
Placemark;Simple Placemark
Placemark;Floating Placemark
Ground Overlays
Ground Overlays;0 Rotation - Image
Ground Overlays;0 Rotation - Color
...

Group Membership

This command belongs to the following group(s):

VO

VO Window

Version

9.2

STK Programming Interface 11.0.1