Graphics3DDataDisplayElement#

class ansys.stk.core.stkobjects.Graphics3DDataDisplayElement#: Class defining 3D Graphics data display element.

Overview#

Methods

`is_displayed_in_window`	Opt whether to show the data display in the selected location.
`add_to_window`	Add the data display to a 3D window.
`remove_from_window`	Remove the data display from a 3D window.
`add_to_all_windows`	Add the data display to all 3D windows.

Properties

`name`	Name of data display element.
`show_graphics`	Opt whether to show the data display element.
`location`	Get or set the location where the data display is to appear: 3D window, data display area, or offset from the selected object.
`x_origin`	Get or set the horizontal point of origin for the marker (left, center or right).
`x`	Amount of X offset from the origin. Dimensionless.
`y_origin`	Get or set the vertical point of origin for the marker (top, center or bottom.).
`y`	Amount of Y offset from the origin. Dimensionless.
`title`	Opt whether to show the title of the data display.
`font_size`	Font size of the data display.
`font_color`	Font color of the data display.
`format`	Font format of the data display.
`use_background`	Opt whether to use a background with the data display.
`transparent_background`	Opt whether to make the background transparent.
`background_width`	Get or set the width of the data display background. Dimensionless.
`background_height`	Get or set the height of the data display background. Dimensionless.
`background_color`	Get or set the color of the data display background.
`available_windows`	Get the available 3D windows for the data display.
`title_text`	Get or set the title of the data display.
`background_translucency`	Get or set the translucency of the background between 0 and 1 inclusive.
`use_background_texture`	Opt whether to use a background texture with the data display.
`background_texture_filename`	Get or set the filename of the background texture.
`use_background_border`	Opt whether to use a background border with the data display.
`background_border_color`	Get or set the color of the border surrounding the data display background.
`use_automatic_size_width`	Opt whether to allow automatic resizing of data display width.
`use_automatic_size_height`	Opt whether to allow automatic resizing of data display height.
`show_name`	Opt whether to show an objects name in the data display title.

Examples#

Add a Data Display to the 3D Window

# Satellite satellite: Satellite object
# Remove all data displays so you can easily pick one that may already be in
# the list
satellite.graphics_3d.data_display.remove_all()
# Add LLA data display and change size/title
datadisplay = satellite.graphics_3d.data_display.add("LLA Position")
datadisplay.show_graphics = True
datadisplay.font_size = Graphics3DFontSize.MEDIUM
datadisplay.title_text = "My Data Display"
datadisplay.show_name = False

Import detail#

from ansys.stk.core.stkobjects import Graphics3DDataDisplayElement

Property detail#

property Graphics3DDataDisplayElement.name: str#: Name of data display element.

property Graphics3DDataDisplayElement.show_graphics: bool#: Opt whether to show the data display element.

property Graphics3DDataDisplayElement.location: Graphics3DLocation#: Get or set the location where the data display is to appear: 3D window, data display area, or offset from the selected object.

property Graphics3DDataDisplayElement.x_origin: Graphics3DXOrigin#: Get or set the horizontal point of origin for the marker (left, center or right).

property Graphics3DDataDisplayElement.x: int#: Amount of X offset from the origin. Dimensionless.

property Graphics3DDataDisplayElement.y_origin: Graphics3DYOrigin#: Get or set the vertical point of origin for the marker (top, center or bottom.).

property Graphics3DDataDisplayElement.y: int#: Amount of Y offset from the origin. Dimensionless.

property Graphics3DDataDisplayElement.title: bool#: Opt whether to show the title of the data display.

property Graphics3DDataDisplayElement.font_size: Graphics3DFontSize#: Font size of the data display.

property Graphics3DDataDisplayElement.font_color: Color#: Font color of the data display.

property Graphics3DDataDisplayElement.format: Graphics3DFormat#: Font format of the data display.

property Graphics3DDataDisplayElement.use_background: bool#: Opt whether to use a background with the data display.

property Graphics3DDataDisplayElement.transparent_background: bool#: Opt whether to make the background transparent.

property Graphics3DDataDisplayElement.background_width: int#: Get or set the width of the data display background. Dimensionless.

property Graphics3DDataDisplayElement.background_height: int#: Get or set the height of the data display background. Dimensionless.

property Graphics3DDataDisplayElement.background_color: Color#: Get or set the color of the data display background.

property Graphics3DDataDisplayElement.available_windows: list#: Get the available 3D windows for the data display.

property Graphics3DDataDisplayElement.title_text: str#: Get or set the title of the data display.

property Graphics3DDataDisplayElement.background_translucency: float#: Get or set the translucency of the background between 0 and 1 inclusive.

property Graphics3DDataDisplayElement.use_background_texture: bool#: Opt whether to use a background texture with the data display.

property Graphics3DDataDisplayElement.background_texture_filename: str#: Get or set the filename of the background texture.

property Graphics3DDataDisplayElement.use_background_border: bool#: Opt whether to use a background border with the data display.

property Graphics3DDataDisplayElement.background_border_color: Color#: Get or set the color of the border surrounding the data display background.

property Graphics3DDataDisplayElement.use_automatic_size_width: bool#: Opt whether to allow automatic resizing of data display width.

property Graphics3DDataDisplayElement.use_automatic_size_height: bool#: Opt whether to allow automatic resizing of data display height.

property Graphics3DDataDisplayElement.show_name: bool#: Opt whether to show an objects name in the data display title.

Method detail#

Graphics3DDataDisplayElement.is_displayed_in_window(self, title: str) → bool#

Opt whether to show the data display in the selected location.

Parameters:: title : str
Returns:: bool

Graphics3DDataDisplayElement.add_to_window(self, title: str) → None#

Add the data display to a 3D window.

Parameters:: title : str
Returns:: None

Graphics3DDataDisplayElement.remove_from_window(self, title: str) → None#

Remove the data display from a 3D window.

Parameters:: title : str
Returns:: None

Graphics3DDataDisplayElement.add_to_all_windows(self) → None#

Add the data display to all 3D windows.

Returns:: None