Control the display of annotations in the 3D window
VO <ScenarioPath> Annotation {AnnotationAction} <Parameters>
The VO Annotation command allows the user to display textual data in the 3D window. You can also control the position, color and size of the data being displayed.
| {AnnotationAction} | <Parameters> |
|---|---|
| Add | <AnnotationName> Text [{AnnotationOption} <Value> {AnnotationOption2} <Value>...] |
| Modify | |
| Delete | {<AnnotationName> | AllAnnotations} Text |
Note: The <AnnotationName> must be a unique identifier for the text annotation. If you attempt to add an annotation with the same name using add, the command will NACK. If the annotation name cannot be found for the modify or delete commands, they will also NACK.
If {AnnotationAction} is Add or Modify the following {AnnotationOptions} <Value> pairs are available:
Note: {AnnotationOptions} can be specified in any order, and any number of {AnnotationOptions} can be used in a single command.
| {AnnotationOption} | <Value> | Description |
|---|---|---|
| String | "<AnnotationText>" [String "<AnnotationText2>"] | The actual text that should display as the annotation. Multiple text strings can be added each time the command is issued. The "<AnnotationText>" from each String "<AnnotationText>" keyword combination will appear on a separate line in the 3D window. |
| Coord | {LatLon | Pixel} | Indicate the spacing used to draw annotations. |
| Position | <XPosition/Longitude> <YPosition/Latitude> <ZPosition/Altitude> |
If Coord is Pixel then <XPosition> and <YPosition> parameters allows you to set the position of the text, where (0,0) is defined as the lower left corner of the 3D window. If Coord is LatLon then enter the <Longitude> and <Latitude> values, in this order, to set the position of the text. |
| Color | {Color} | Specify the annotation color. For valid {Color} options see Common Options. |
| FontStyle | {Small | Medium | Large} | {FontStyle} controls the size of the text displayed in the 3D window. |
| CentralBody | <CBName> | If the <Coord> is <LatLon>, the annotation will show relative to the central body specified using <CBName>. The central body used will be that of the scenario if none is specified. |
| HorizPixelOrigin | {Left | Right} | Sets the horizontal origin of the annotation to the left or right side of the screen. If not specified, the default is Left. |
| VertPixelOrigin | {Top | Bottom} | Sets the vertical origin of the annotation to the top or bottom of the screen. If not specified, the default is Bottom. |
| WindowID | <WinNumber> | Indicate the 3D window within which the annotation should appear. If you don't specify a <WinNumber>, the annotations will appear in all 3D windows. If you specify a <WinNumber> that doesn't exist, Connect returns a NACK. |
| Interval | {Action} [<Parameters>] | Indicate the intervals during which the annotation should display. |
If {AnnotationOption} is Interval, {Action} can be:
| {Action} | <Parameters> | Description |
|---|---|---|
| Add | <NumIntervalPairs> "<IntervalStart>" "<IntervalStop>" ["<IntervalStart>" "<IntervalStop>"...] | Adds intervals to the list of display times. The number of "<IntervalStart>" "<IntervalStop>" value sets to be entered depends on the <NumIntervalPairs> specified. |
| Load | "<FilePath>" | Replaces or create the interval list with the intervals specified in the interval list file. The file must be in the STK interval list file format and end with an .int extension. |
| Import | "<TimeComponent>" | Replaces or create the interval list
with the intervals specified in the Interval or Interval List
"<TimeComponent>".
For information about "<TimeComponent>" see Component Specification. |
| Clear | N/A | Remove all display intervals for the display list. |
Hint: Number assignments for colors are stored in the <STKUserDir>\Config\Defaults\_Default.ap file and can be viewed, edited and stored.
To Add a red text annotation with the string "LatLonAnnotation" at the lat,lon,alt position of 10,30,1000:
VO * Annotation Add annotation1 Text String "LatLonAnnotation" Coord LatLon Position 30 10 1000 Color red
To add the same three lines that were added in the above example, but with each on a separate line in the 3D Graphics window:
VO * Annotation Add annotation1 Text String "Lat" String "Lon" String "Annotation" Coord LatLon Position 30 10 1000 Color red
To Add a blue text annotation with the string "MarsLatLon" at the lat,lon,alt position of -30,100,0 on the central body of Mars:
VO * Annotation Add annotation2 Text String "MarsLatLon" Coord latlon Position 100 -30 0 Color blue CentralBody Mars
To Add a yellow text annotation with the string "PixelAnnotation" at the pixel position of 50,100 relative to the lower left corner of the screen only on 3D windows with ids of 1 and 4:
VO * Annotation Add annotation3 Text String "PixelAnnotation" Coord pixel Position 50 100 0 Color yellow VertPixelOrigin bottom WindowID 1 WindowID 4
To Modify annotation with annotation id annotation3 by changing the text to "NewString" and moving it to position 200,50:
VO * Annotation Modify annotation3 Text String "NewString" Position 200 50 0
To Delete annotation with annotation id annotation1:
VO * Annotation Delete annotation1 Text
To add annotation3, in the position 50 20, and have it dislplay the two intervals specified:
VO * Annotation Add annotation3 Text String "IntervalText3" Position 50 20 0 Interval Add 2 "1 Jan 2001 00:00:00.00" "1 Jan 2001 01:00:00.00" "1 Jan 2001 01:20:00.00" "1 Jan 2001 02:30:00.00"
To add two additional intervals to annotation3:
VO * Annotation Modify annotation3 Text Interval Add 2 "1 Jan 2001 01:40:00.00" "1 Jan 2001 02:20:00.00" "1 Jan 2001 02:40:00.00" "1 Jan 2001 03:10:00.00"
To change the string for annotation3, and replace the interval list with the intervals in the file TestInt.int:
VO * Annotation Modify annotation3 Text String "LoadIntervalTest" Interval Load "e:/master42/TestInt.int"
To clear all intervals from annotation3:
VO * Annotation Modify annotation3 Text Interval Clear
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
10
STK Programming Interface 11.0.1