Description | Example | Return Message | Group

VO BearingBox

Define a volume, relative to a bearing from the North, around an object.

Syntax

VO <ObjectPath> BearingBox {Keyword} <Value> [{Keyword} <Value>...]

Related Commands

Description

Create and set attributes for a bearing box to appear around a vehicle, facility or place. The box is defined relative to a bearing from the North.

Note: The BorderWall keyword must come last in the command syntax or the command will NACK.

{Keyword} <Value> Description
Show {On | Off} Show or hide the bearing box.
Color {Color} Set the color of the bearing box. For valid {Color} options see Common Options.
LineStyle {LineStyle} Set the line style of the bearing box. For valid {LineStyle} options see Common Options.
LineWidth <LineWidth> Indicate a pixel width value between 1.0 and 10.0.
UseTranslucency {On | Off} Set UseTranslucency to On to use the value in the Translucency option for the box walls.
Translucency <Value> Valid value is 0 - 100, where 0 is opaque and 100 is transparent. Default is 90.
Bearing <Value> The bearing value, relative to North. Entered in degrees.
XLength <Value> Indicates the length of the box, along the bearing. <Value> must be greater than 0 and is entered in Connect distance units. Default is 120,000 m for Vehicles and 24,000 m for Facility or Place.
YLength <Value> Indicates the width of the box, across the bearing. <Value> must be greater than 0 and is entered in Connect distance units. Default is 100,000 m for Vehicles and 16,000 m for Facility or Place.
ZLength <Value> Indicates the height of the box. <Value> must be entered in Connect distance units. Default is 40,000 m for Vehicles and 6,000 m for Facility or Place.
XOffset <Value> The distance to offset the box (forward or backward) along the bearing. A positive XOffset <Value> moves the box forward. Entered in Connect distance units.
YOffset <Value> The distance to offset the box (left or right) along the bearing. A positive YOffset <Value> moves the box to the right. Entered in Connect distance units.
ZOffset <Value> The distance to offset the box (up or down). A positive ZOffset <Value> moves the box down, towards the ground. Entered in Connect distance units.
ShowLabels {On | Off} Show or hide the Length and Width labels.
ShowText {On | Off} Show or hide the user defined text.
Text "<Text>" Set user defined text.
BorderWall {Options} Instead of drawing as a cube, the bearing box can be drawn as a border wall. For the options available see VO BorderWall.

Note: The BorderWall keyword must come last in the command syntax or the command will NACK.

Note: The bearing box will render much faster as a cube than a Borderwall, especially if the border wall is drawn relative to terrain.

When the border wall is displayed, the bearing box's UseTranslucency, Translucency, Height and HeightOffset have no effect on the border wall. Instead, use the following border wall options: UseTranslucency, Translucency, BottomAltRef, TopAltRef, BottomAltRefValue, and TopAltRefValue.

Note: The following keywords have been deprecated in STK10.1.

The deprecated keywords will be maintained for backward compatibility only. They have been replaced by keywords that allow <Value> to be entered in Connect distance units, rather than being restricted to meters.

Deprecated Keyword Use this instead:
Length XLength
Width YLength
Height ZLength
LengthOffset XOffset
WidthOffset YOffset
HeightOffset ZOffset

Example

Show a BearingBox for FacTest1, with a bearing 45 degrees off North, length 20000m and width of 10000m:

VO */Facility/FacTest1 BearingBox Show On Bearing 45 xlength 20000 ylength 10000

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Facilities, Places & Targets

Vehicles

VO

VO Objects

Version

10.1

STK Programming Interface 11.0.1