Description

Interface for 3D Graphics window data display element.

Public Methods

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

Public Properties

AvailableWindows	Get the available 3D windows for the data display.
BackgroundBorderColor	The color of the border surrounding the data display background.
BackgroundTextureFilename	The filename of the background texture.
BackgroundTranslucency	The translucency of the background between 0 and 1 inclusive.
BgColor	The color of the data display background.
BgHeight	The height of the data display background. Dimensionless.
BgWidth	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	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	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	The horizontal point of origin for the marker (left, center or right).
Y	Amount of Y offset from the origin. Dimensionless.
YOrigin	The vertical point of origin for the marker (top, center or bottom.)

Example

Configure 3D data display

[C#] Copy Code

// 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#] Copy Code

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

Configure 3D data display

[Visual Basic .NET] Copy Code

' 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

Delay graphics updates while manipulating properties of an object

[Visual Basic .NET] Copy Code

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

Add a Data Display to the 3D Window

[MATLAB] Copy Code

% 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;

Add a Data Display to the 3D Window

[Python] Copy Code

# 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 = 1 # eMedium 
datadisplay.TitleText = 'My Data Display' 
datadisplay.IsShowNameEnabled = False

AGI STK Objects 11	Send comments on this topic.
IAgVODataDisplayElement Interface