Description | Example | Return Message | Group

VO_RM Annotation

Return information about text annotations on a 3D window.

Syntax

VO_RM <ScenarioPath> Annotation {Option} [WindowID <WinNumber>]

Related Commands

Description

The VO_RM Annotation command will return a list containing information about text annotations. Specify WindowID <WinNumber> to return annotations for a specific 3D window.

The following information is returned for each annotation: <name>, <color>, {LLA | Pixel}, <lat/x>, <lon/y>, <alt>, <text>

<color> is returned in hexadecimal format. If the position type is LLA then <lat> and <lon> are returned in degrees, and <alt> is returned in Connect distance units. If the position type is Pixel then <x> and <y> are returned. <text> is the first 30 characters of the annotation.

The following table describes the {Option} values.

{Option} Description
All Return all text annotations.
Count Count option returns the number of text annotations.
<Name> Return only the annotation matching the <Name>.

Example

Return information on all text annotation:

VO_RM * Annotation All

ReturnMessage

Annotation1, #ffff00, LLA, 46.000000, -75.000000, 0.000000, The scenario starts here.
Test2, #00ff00, Pixel, 55.000000, 35.000000, Another test of the text annot
UI3, #ff6a6a, LLA, 0.500000, -40.000000, 135.00000, The VO_RM Annotation command w

Example

Return the number of text annotations on 3D window 1:

VO_RM * Annotation Count WindowID 1

ReturnMessage

3

Group Membership

This command belongs to the following group(s):

VO

VO Window

Version

10.1

STK Programming Interface 11.0.1