VO Annotation
Control the display of annotations in the 3D window.
Syntax
VO <ScenarioPath> Annotation {AnnotationAction} <Parameters>
Related commands
- VO_RM Annotation
- VO Annotation DataDisplayArea
- VO Annotation Declutter
- VO Annotation Frame
- VO Annotation Selection
- VO Annotation Time
- VO Annotation ViewerPos
Description
The VO Annotation command enables you to display textual data in the 3D Graphics 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 |
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 STK cannot find the annotation name for the modify or delete commands, they will also NACK.
If {AnnotationAction} is Add or Modify, the following {AnnotationOptions} <Value> pairs are available:
You can specify {AnnotationOptions} in any order and use any number of {AnnotationOptions} in a single command.
| {AnnotationOption} | <Value> | Description |
|---|---|---|
| String | "<AnnotationText>" [String "<AnnotationText2>"] | This is the actual text that should appear as the annotation. You can add two or more text strings each time you issue the command. The "<AnnotationText>" from each String "<AnnotationText>" keyword combination will appear on a separate line in the 3D Graphics 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 enables you to set the position of the text, where (0,0) is defined as the lower-left corner of the 3D Graphics 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 Graphics window. |
| CentralBody | <CBName> | If the <Coord> is <LatLon>, the annotation will show relative to the central body specified using <CBName>. If you do not specify CentralBody, STK will use the central body of the scenario. |
| 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 Graphics window within which the annotation should appear. If you don't specify a <WinNumber>, the annotations will appear in all 3D Graphics 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 appear. |
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 creates 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.
"<FilePath>" is the path to a file on your local drive. |
| Import | "<TimeComponent>" | Replaces or creates 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. |
Number assignments for colors are stored in the <STKUserDir>\Config\Defaults\_Default.ap file. You can view, edit, and store them.
Examples
To Add a red text annotation with the string "LatLonAnnotation" at the lat,lon,alt position of 10,30,1000:
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:
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:
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:
To Modify annotation with annotation id annotation3 by changing the text to "NewString" and moving it to position 200,50:
To Delete annotation with annotation id annotation1:
To add annotation3, in the position 50 20, and have it dislplay the two intervals specified:
To add two additional intervals to annotation3:
To change the string for annotation3, and replace the interval list with the intervals in the file TestInt.int:
To clear all intervals from annotation3:
Return message
Group membership
This command belongs to the following group(s):
Version
12.10