Description

Interface for 3D Graphics window data display element.

Public Methods

AddToAllWindows	Add the data display to all 3D windows.
AddToWindow	Add the data display to a 3D window.
IsDisplayedInWindow	Opt whether to show the data display in the selected location.
RemoveFromWindow	Remove the data display from a 3D window.

Public Properties

AvailableWindows	Get the available 3D windows for the data display.
BackgroundBorderColor	Gets or sets the color of the border surrounding the data display background.
BackgroundTextureFilename	Gets or sets the filename of the background texture.
BackgroundTranslucency	Gets or sets the translucency of the background between 0 and 1 inclusive.
BgColor	Gets or sets the color of the data display background.
BgHeight	Gets or sets the height of the data display background. Dimensionless.
BgWidth	Gets or sets the width of the data display background. Dimensionless.
FontColor	Font color of the data display.
FontSize	Font size of the data display.
Format	Font format of the data display.
IsShowNameEnabled	Opt whether to show an objects name in the data display title.
IsVisible	Opt whether to show the data display element.
Location	Gets or sets the location where the data display is to appear: 3D window, data display area, or offset from the selected object.
Name	Name of data display element.
Title	Opt whether to show the title of the data display.
TitleText	Gets or sets the title of the data display.
TransparentBg	Opt whether to make the background transparent.
UseAutoSizeHeight	Opt whether to allow automatic resizing of data display height.
UseAutoSizeWidth	Opt whether to allow automatic resizing of data display width.
UseBackground	Opt whether to use a background with the data display.
UseBackgroundBorder	Opt whether to use a background border with the data display.
UseBackgroundTexture	Opt whether to use a background texture with the data display.
X	Amount of X offset from the origin. Dimensionless.
XOrigin	Gets or sets the horizontal point of origin for the marker (left, center or right).
Y	Amount of Y offset from the origin. Dimensionless.
YOrigin	Gets or sets the vertical point of origin for the marker (top, center or bottom.).

Example

Configure 3D data display

[C#]

// Add existing data display
// See AvailableData property for available data display
IAgVODataDisplayElement displayElement = datadisplaycol.Add("Solar Intensity");

// Configure data display as needed
displayElement.TitleText = "Sol. Intensity";
displayElement.IsVisible = true;
displayElement.Location = AgEVOLocation.e3DWindow;
displayElement.FontColor = Color.White;
displayElement.FontSize = AgEVOFontSize.eSmall;
displayElement.UseBackground = true;
displayElement.BgColor = Color.Orange;
displayElement.UseAutoSizeWidth = false;
displayElement.UseAutoSizeHeight = false;
displayElement.BgHeight = 55;
displayElement.BgWidth = 260;
displayElement.BackgroundTranslucency = 0.5;
displayElement.UseBackgroundTexture = false;
displayElement.UseBackgroundBorder = true;
displayElement.BackgroundBorderColor = Color.White;

Delay graphics updates while manipulating properties of an object

[C#]

IAgSatellite satellite = root.CurrentScenario.Children["Satellite1"] as IAgSatellite;
IAgVODataDisplayElement voElt = satellite.VO.DataDisplay[0];

root.BeginUpdate(); // Suspend updates

// Put modifications here
voElt.IsVisible = true;
voElt.UseBackground = true;
voElt.BgColor = Color.Green;
voElt.UseBackground = false;

root.EndUpdate(); // Resume updates now

Delay graphics updates while manipulating properties of an object

[Visual Basic .NET]

Dim satellite As IAgSatellite = TryCast(root.CurrentScenario.Children("Satellite1"), IAgSatellite)
Dim voElt As IAgVODataDisplayElement = satellite.VO.DataDisplay(0)

root.BeginUpdate()
' Suspend updates
' Put modifications here
voElt.IsVisible = True
voElt.UseBackground = True
voElt.BgColor = Color.Green
voElt.UseBackground = False

root.EndUpdate()
' Resume updates now

Configure 3D data display

[Visual Basic .NET]

' Add existing data display
' See AvailableData property for available data display
Dim displayElement As IAgVODataDisplayElement = datadisplaycol.Add("Solar Intensity")

' Configure data display as needed
displayElement.TitleText = "Sol. Intensity"
displayElement.IsVisible = True
displayElement.Location = AgEVOLocation.e3DWindow
displayElement.FontColor = Color.White
displayElement.FontSize = AgEVOFontSize.eSmall
displayElement.UseBackground = True
displayElement.BgColor = Color.Orange
displayElement.UseAutoSizeWidth = False
displayElement.UseAutoSizeHeight = False
displayElement.BgHeight = 55
displayElement.BgWidth = 260
displayElement.BackgroundTranslucency = 0.5
displayElement.UseBackgroundTexture = False
displayElement.UseBackgroundBorder = True
displayElement.BackgroundBorderColor = Color.White

Add a Data Display to the 3D Window

[Python - STK API]

# IAgSatellite satellite: Satellite object
# Remove all data displays so you can easily pick one that may already be in
# the list
satellite.VO.DataDisplay.RemoveAll()
# Add LLA data display and change size/title
datadisplay = satellite.VO.DataDisplay.Add('LLA Position')
datadisplay.IsVisible = True
datadisplay.FontSize = AgEVOFontSize.eMedium
datadisplay.TitleText = 'My Data Display'
datadisplay.IsShowNameEnabled = False

Add a Data Display to the 3D Window

[MATLAB]

% IAgSatellite satellite: Satellite object
% Remove all data displays so you can easily pick one that may already be in
% the list
satellite.VO.DataDisplay.RemoveAll;
% Add LLA data display and change size/title
datadisplay = satellite.VO.DataDisplay.Add('LLA Position');
datadisplay.IsVisible = true;
datadisplay.FontSize = 'eMedium';
datadisplay.TitleText = 'My Data Display';
datadisplay.IsShowNameEnabled = false;

STK Objects	Send comments on this topic.
IAgVODataDisplayElement Interface