Control the display and placement of overlay images in a 3D window.
VO <ScenarioPath> Overlay {Action} "<FilePath>" [{OverlayOption} <Value>]
The VO Overlay command allows you to control the image overlays shown in the 3D window as well as the placement of those overlays.
{Action} can be Add, Modify, or Remove.
If {Action} is Add then "<FilePath>" must contain the complete filepath, including directory specification. If {Action} is Modify or Remove then the "<FilePath>" can be the full path or just the filename without a path. If just a filename is entered STK will find the first occurrance of the overlay that matches that filename and remove or modify it.
To modify the position of the Microsoft Bing™ Maps logo see the MSBingMaps section below.
{OverlayOption} and <Value> can be:
| {OverlayOption} | <Value> | Description |
|---|---|---|
| Show | On | Displays the selected image in the 3D Graphics window and enables you to modify the following attributes. |
| Off | Hides the selected image in the 3D Graphics window. | |
| XOrigin | Left | The horizontal attach point for an image. |
| Right | ||
| Center | ||
| Banner | ||
| XPosition | <Value> | 0-1000 value representing the offset from the horizontal attach point. |
| YOrigin | Top | The vertical attach point for an image. |
| Bottom | ||
| Center | ||
| Banner | ||
| YPosition | <Value> | 0-1000 value representing the offset from the vertical attach point. |
| Scale | <ScaleValue> | 0.001 - 1000.0 value to which the image will be scaled relative to its original dimensions. The default value is a one-to-one scale (1.0 value). Values lower than one will make the image appear smaller; values larger than one will make the image appear larger. |
| Transparent | On | Makes the image background transparent. |
| Off | The image background is visible. | |
| FirstPixelTranspColor | {On | Off} | Enter On to use the first pixel in the image to determine which color will be the transparent color. |
| WindowID | {<WinNumber> | All} | Enter the number of the 3D window to which the changes should be applied. Enter All to have an overlay displayed or changed in all 3D Windows. |
Hint: The Banner value for XOrigin and YOrigin stretches the image along the X or Y axis. As a result, the image may appear stretched in one direction or another, depending on the original size and aspect ratio of the image.
To modify the origin of the Microsoft Bing Maps logo use this format:
VO <ScenarioPath> Overlay Modify MSBingMaps {Options}
The {Options} can be:
| {Options} | Description |
|---|---|
| XOrigin {Left | Right | Center} | The horizontal attach point for the logo. |
| YOrigin {Top | Bottom | Center} | The vertical attach point for the logo. |
| WindowID {<WinNumber> | All} | Enter the number of the 3D window to which the changes should be applied. Enter All to have the logo changed in all 3D Windows. |
To display the AirForceStar image in the upper right corner of 3D Graphics window 2 with a transparent background:
VO * Overlay Add "C:\STKInstall\STKData\VO\Textures\AirForceStar.tga" XOrigin Right YOrigin Top Transparent On WindowID 2
To modify the image set to display in the previous command so that its background is visible, and scale the image down slightly:
VO * Overlay Modify "AirForceStar.tga" Scale 0.7 Transparent Off WindowID 2
To change the position of the Microsoft Bing Maps logo:
VO * Overlay Modify MSBingMaps xOrigin center yOrigin center
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
10.1
STK Programming Interface 11.0.1