Description | Example | Return Message | Group

VO Declutter

Reposition the labels on objects that are close together so they don't obstruct one another.

Syntax

VO <ScenarioPath> Declutter {DeclutterOption} <DeclutterValue> [{DeclutterOption} <DeclutterValue>...]

Description

The VO Declutter command provides the ability to separate the labels on objects that are in close proximity on the display to allow for better identification in small areas. The declutter feature repositions the labels so they don't obstruct one another.

{DeclutterOption} <DeclutterValue> Description
Enable {On | Off} Turns declutter on or off. Defaults to Off.
ShowLines {On | Off} Shows lines connecting decluttered labels to their original position. Defaults to On.
Mode {Simple | MinimizeDistance | AvoidTerrainOnly} Select the mode for label declutter. The default is MinimizeDistance.
  • Simple - standard declutter mode
  • MinimizeDistance - Smooths and minimizes the length of the connecting lines.
  • AvoidTerrainOnly - Shifts labels away from terrain but does not shift labels away from each other.
AvoidTerrain {Never | Always | Auto} When the mode is set to Auto, Terrain Avoidance is only performed when there is depth buffer terrain being shown. Terrain Avoidance is a feature that declutters labels away from the central body and towards the viewer. That has a general effect of keeping the labels from being obscured by the terrain. Defaults to Auto.
ShiftFromTerrain <ShiftValue> Integer from 0 to 2048. Minimum number of pixels that labels must be shifted away from the central body when the view is directed towards the horizon. Defaults to 75.
ForceReset {On | Off} Forces decluttered label positions to be recomputed. This has the same effect as turning declutter off and then back on.
MaxPixelsPerSec <Value> This option will allow the user to minimize quick label movements at high frame rates. The lower the value the slower the label movement will be. The <Value> is an integer from 0 to 10000, default value is 80. This option applies to MinimizeDistance Mode only.
WindowID <WinNumber> The ID number of the VO window to be affected. Defaults to the first window.

Example

To enable declutter, but not show lines connecting labels to their original positions:

VO * Declutter Enable On ShowLines Off

To enable declutter, set terrain avoidance to Auto and shift labels 80 pixels away fromt he central body:

VO * Declutter Enable On AvoidTerrain Auto ShiftFromTerrain 80

To force a declutter reset for VO window 2:

VO * Declutter ForceReset On WindowID 2

To show lines connecting labels, set the declutter mode and set quick label movement:

VO * Declutter ShowLines On Mode MinimizeDistance MaxPixelsPerSec 10000

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

VO

VO Window

Version

7.0

STK Programming Interface 11.0.1