ScenarioGraphics3D#

class ansys.stk.core.stkobjects.ScenarioGraphics3D#: Class defining 3D Graphics properties of the Scenario.

Overview#

Methods

`available_marker_types`	Retrieve the list of available MarkerTypes.
`show_object`	Show the object identified by its path in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to show the object in all 3d windows.
`show_objects`	Show multiple objects in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to show the objects in all 3d windows.
`hide_object`	Hides the object identified by its path in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to hide the object in all 3d windows.
`hide_objects`	Hides multiple objects in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to hide objects in all 3d windows.

Properties

`chunk_image_cache_size`	Chunk image cache size (MB). The texture cache temporarily stores chunk imagery for the globe. You may need to increase the size of the cache if all specified terrain cannot be loaded at the same time or the terrain is blurry.
`is_negative_altitude_allowed`	Specify whether to allow negative altitudes for great arc vehicles and for facilities, places and targets.
`small_font`	Retrieve small font metrics.
`medium_font`	Retrieve medium font metrics.
`large_font`	Retrieve large font metrics.
`surface_reference`	Opt to display the globe’s surface at the mean sea level (MSL) or at the central body’s reference ellipsoid (WGS84).
`draw_on_terrain`	If true, lines drawn on the globe such as those that define area and line targets, range rings, vehicle paths, map details, etc. will conform to the terrain on the globe. Otherwise, if terrain is present, the lines may go under or float over the terrain.
`chunk_terrain_cache_size`	Chunk terrain cache size (MB).
`text_outline_style`	Default text outline style.
`text_outline_color`	Default text outline color.
`text_anti_aliasing_enabled`	True if the text anti-aliasing is turned on.

Examples#

Change the scenario font

# STKObjectRoot root: STK Object Model Root
scenario = root.current_scenario
scenario.graphics_3d.medium_font.name = "Arial"
scenario.graphics_3d.medium_font.point_size = 18
scenario.graphics_3d.medium_font.bold = True
scenario.graphics_3d.medium_font.italic = False

Import detail#

from ansys.stk.core.stkobjects import ScenarioGraphics3D

Property detail#

property ScenarioGraphics3D.chunk_image_cache_size: int#: Chunk image cache size (MB). The texture cache temporarily stores chunk imagery for the globe. You may need to increase the size of the cache if all specified terrain cannot be loaded at the same time or the terrain is blurry.

property ScenarioGraphics3D.is_negative_altitude_allowed: bool#: Specify whether to allow negative altitudes for great arc vehicles and for facilities, places and targets.

property ScenarioGraphics3D.small_font: Scenario3dFont#: Retrieve small font metrics.

property ScenarioGraphics3D.medium_font: Scenario3dFont#: Retrieve medium font metrics.

property ScenarioGraphics3D.large_font: Scenario3dFont#: Retrieve large font metrics.

property ScenarioGraphics3D.surface_reference: SurfaceReference#: Opt to display the globe’s surface at the mean sea level (MSL) or at the central body’s reference ellipsoid (WGS84).

property ScenarioGraphics3D.draw_on_terrain: bool#: If true, lines drawn on the globe such as those that define area and line targets, range rings, vehicle paths, map details, etc. will conform to the terrain on the globe. Otherwise, if terrain is present, the lines may go under or float over the terrain.

property ScenarioGraphics3D.chunk_terrain_cache_size: int#: Chunk terrain cache size (MB).

property ScenarioGraphics3D.text_outline_style: TextOutlineStyle#: Default text outline style.

property ScenarioGraphics3D.text_outline_color: Color#: Default text outline color.

property ScenarioGraphics3D.text_anti_aliasing_enabled: bool#: True if the text anti-aliasing is turned on.

Method detail#

ScenarioGraphics3D.available_marker_types(self) → list#

Retrieve the list of available MarkerTypes.

Returns:: list

ScenarioGraphics3D.show_object(self, trunc_path: str, window_id: str) → None#

Show the object identified by its path in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to show the object in all 3d windows.

Parameters:

trunc_path : str

window_id : str

Returns:

None

ScenarioGraphics3D.show_objects(self, trunc_object_paths: list, window_id_or_title: str) → None#

Show multiple objects in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to show the objects in all 3d windows.

Parameters:

trunc_object_paths : list

window_id_or_title : str

Returns:

None

ScenarioGraphics3D.hide_object(self, trunc_path: str, window_id: str) → None#

Hides the object identified by its path in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to hide the object in all 3d windows.

Parameters:

trunc_path : str

window_id : str

Returns:

None

ScenarioGraphics3D.hide_objects(self, trunc_object_paths: list, window_id_or_title: str) → None#

Hides multiple objects in a specified 3D window. Users can specify either a window identifier or a window title or ‘all’ to hide objects in all 3d windows.

Parameters:

trunc_object_paths : list

window_id_or_title : str

Returns:

None