Description | Example | Return Message | Group

VO ControlBox

Define a volume around an object that moves with the object.

Syntax

VO <VehObjectPath> ControlBox {Keyword} <Value> [{Keyword} <Value>...]

Related Commands

Description

Create and set attributes for a control box to appear around the vehicle.

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 control box.
Color {Color} Set the color of the control box. For valid {Color} options see Common Options.
LineStyle {LineStyle} Set the line style of the control 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.
RefFrame "<RefAxes>" The reference frame is used to align the control box. Default is the vehicle's VNC(CBF) axes.

For details on the format of "<RefAxes>" see Component Specification.

XLength <Value> Indicates how far along the X axis of the reference frame the box extends. <Value> must be greater than 0 and is entered in Connect distance units. Default is 60,000 m.
YLength <Value> Indicates how far along the Y axis of the reference frame the box extends. <Value> must be greater than 0 and is entered in Connect distance units. Default is 50,000 m.
ZLength <Value> Indicates how far along the Z axis of the reference frame the box extends. <Value> must be greater than 0 and is entered in Connect distance units. Default is 20,000 m.
XOffset <Value> The distance to offset the box (positive or negative) along the X axis of the reference frame. Entered in Connect distance units.
YOffset <Value> The distance to offset the box (positive or negative) along the Y axis of the reference frame. Entered in Connect distance units.
ZOffset <Value> The distance to offset the box (positive or negative) along the Z axis of the reference frame. Entered in Connect distance units
ShowLabels {On | Off} Show or hide the X and Y 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 control 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 control 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 control box's UseTranslucency, Translucency, Normal and NormalOffset 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.

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:
Tangential XLength
CrossTrack YLength
Normal ZLength
TangentialOffset XOffset
CrossTrackOffset YOffset
NormalOffset ZOffset

Example

Show the ControlBox for airControlBox:

VO */Aircraft/airControlBox ControlBox Show On

Show and set attributes for a control box around gvBearingControlBox:

VO */GroundVehicle/gvBearingControlBox ControlBox Show On Color Blue XLength 20 XOffset 20 YLength 10 ZLength 10 ZOffset -10

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Vehicles

VO

VO Objects

Version

10

STK Programming Interface 11.0.1