ScenarioGraphics

class ansys.stk.core.stkobjects.ScenarioGraphics

Class defining the 2D Graphics properties of a Scenario.

Overview

Methods

show_object	Show the object identified by its path in a specified 2D window. Users can specify either a window identifier or a window title or ‘all’ to show the object in all 2d windows.
show_objects	Show multiple objects in a specified 2D window. Users can specify either a window identifier or a window title or ‘all’ to show the objects in all 2d windows.
hide_object	Hides the object identified by its path in a specified 2D window. Users can specify either a window identifier or a window title or ‘all’ to hide the object in all 2d windows.
hide_objects	Hides multiple objects in a specified 2D window. Users can specify either a window identifier or a window title or ‘all’ to hide objects in all 2d windows.

Properties

show_label	Specify whether to show labels of objects on the 2D map (general).
show_sensors	Specify whether to show sensors on the 2D map.
access_lines_are_visible	Specify whether to display lines during animation between objects participating in an access.
access_animation_highlights	Specify whether to display access animation highlights, i.e. boxes around objects participating in an access.
access_static_highlights	Specify whether to display access static highlights, i.e. thick lines overlying the ground track of a vehicle during access periods.
show_ground_tracks	Specify whether to display vehicle ground tracks.
show_ground_markers	Specify whether to display vehicle ground markers.
show_orbits	Specify whether to display satellite orbits and trajectories of missiles and launch vehicles.
show_orbit_markers	Specify whether to display satellite orbit markers and missile and launch vehicle trajectory markers.
show_element_set_number	Specify whether to display satellite elset numbers.
show_area_target_centroids	Specify whether to display area target centroids.
show_planet_orbits	Specify whether to display planetary orbits.
show_inertial_position	Specify whether to display the inertial positions of planets.
show_inertial_position_labels	Specify whether to display labels at the inertial positions of planets.
show_sub_planet_points	Specify whether to display sub-planet points.
show_sub_planet_labels	Specify whether to display labels for sub-planet points.
allow_animation_update	Specify whether to allow animation updates.
text_outline_style	Default text outline style.
text_outline_color	Default text outline color.
access_lines_width	Line width of lines between objects participating in an access.
access_line_style	Line style of lines between objects participating in an access.

Import detail

from ansys.stk.core.stkobjects import ScenarioGraphics

Property detail

property ScenarioGraphics.show_label: bool

Specify whether to show labels of objects on the 2D map (general).

property ScenarioGraphics.show_sensors: bool

Specify whether to show sensors on the 2D map.

property ScenarioGraphics.access_lines_are_visible: bool

Specify whether to display lines during animation between objects participating in an access.

property ScenarioGraphics.access_animation_highlights: bool

Specify whether to display access animation highlights, i.e. boxes around objects participating in an access.

property ScenarioGraphics.access_static_highlights: bool

Specify whether to display access static highlights, i.e. thick lines overlying the ground track of a vehicle during access periods.

property ScenarioGraphics.show_ground_tracks: bool

Specify whether to display vehicle ground tracks.

property ScenarioGraphics.show_ground_markers: bool

Specify whether to display vehicle ground markers.

property ScenarioGraphics.show_orbits: bool

Specify whether to display satellite orbits and trajectories of missiles and launch vehicles.

property ScenarioGraphics.show_orbit_markers: bool

Specify whether to display satellite orbit markers and missile and launch vehicle trajectory markers.

property ScenarioGraphics.show_element_set_number: bool

Specify whether to display satellite elset numbers.

property ScenarioGraphics.show_area_target_centroids: bool

Specify whether to display area target centroids.

property ScenarioGraphics.show_planet_orbits: bool

Specify whether to display planetary orbits.

property ScenarioGraphics.show_inertial_position: bool

Specify whether to display the inertial positions of planets.

property ScenarioGraphics.show_inertial_position_labels: bool

Specify whether to display labels at the inertial positions of planets.

property ScenarioGraphics.show_sub_planet_points: bool

Specify whether to display sub-planet points.

property ScenarioGraphics.show_sub_planet_labels: bool

Specify whether to display labels for sub-planet points.

property ScenarioGraphics.allow_animation_update: bool

Specify whether to allow animation updates.

property ScenarioGraphics.text_outline_style: TextOutlineStyle

Default text outline style.

property ScenarioGraphics.text_outline_color: Color

Default text outline color.

property ScenarioGraphics.access_lines_width: int

Line width of lines between objects participating in an access.

property ScenarioGraphics.access_line_style: str

Line style of lines between objects participating in an access.

Method detail

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

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

Parameters:

trunc_path : str

window_id : str

Returns:

None

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

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

Parameters:

trunc_object_paths : list

window_id_or_title : str

Returns:

None

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

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

Parameters:

trunc_path : str

window_id : str

Returns:

None

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

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

Parameters:

trunc_object_paths : list

window_id_or_title : str

Returns:

None