SatelliteGraphics#

class ansys.stk.core.stkobjects.SatelliteGraphics#

Satellite 2D Graphics properties.

Overview#

set_attributes_type

Set the attributes type.

is_attributes_type_supported

Get a value indicating whether the specified type can be used.

attributes_type

Type of 2D Graphics attributes: basic, access intervals or custom intervals.

attributes_supported_types

Return an array of valid choices.

attributes

Get the satellite’s 2D Graphics Attributes.

time_events

Get the satellite’s TimeEvents properties.

passes

Get the pass display settings of the satellite’s Pass properties.

pass_data

Get the leading/trailing ground track and orbit settings of the satellite’s Pass properties.

resolution

Get the path resolution settings of the satellite’s Pass properties.

elevation_contours

Get the satellite’s Elevation Contours properties.

saa

Get the satellite’s South Atlantic Anomaly Contour properties.

range_contours

Get the satellite’s Range Contours properties.

lighting

Get the satellite’s Lighting properties.

swath

Get the satellite’s Swath properties.

ground_ellipses

Get the satellite’s Ground Ellipses properties.

label_notes

Notes attached to the object and displayed in the 2D and 3D Graphics windows.

ground_track_central_body_display

Get the ground track display central bodies.

use_instance_name_label

Specify whether to use the name of the satellite (as shown in the Object Browser) as its label.

label_name

The user-specified name to use as a label for the satellite.

show_graphics

Specify whether graphics attributes of the satellite are visible.

radar_cross_section

Get the radar cross section graphics interface.

Examples#

Change the Display Label of the vehicle

# Satellite satellite: Satellite object
satellite.graphics.use_instance_name_label = False
satellite.graphics.label_name = "Python Satellite"

Import detail#

from ansys.stk.core.stkobjects import SatelliteGraphics

Property detail#

property SatelliteGraphics.attributes_type: VehicleGraphics2DAttributeType#

Type of 2D Graphics attributes: basic, access intervals or custom intervals.

property SatelliteGraphics.attributes_supported_types: list#

Return an array of valid choices.

property SatelliteGraphics.attributes: IVehicleGraphics2DAttributes#

Get the satellite’s 2D Graphics Attributes.

property SatelliteGraphics.time_events: VehicleGraphics2DTimeEventsCollection#

Get the satellite’s TimeEvents properties.

property SatelliteGraphics.passes: VehicleGraphics2DPasses#

Get the pass display settings of the satellite’s Pass properties.

property SatelliteGraphics.pass_data: VehicleGraphics2DOrbitPassData#

Get the leading/trailing ground track and orbit settings of the satellite’s Pass properties.

property SatelliteGraphics.resolution: VehicleGraphics2DPassResolution#

Get the path resolution settings of the satellite’s Pass properties.

property SatelliteGraphics.elevation_contours: VehicleGraphics2DElevationContours#

Get the satellite’s Elevation Contours properties.

property SatelliteGraphics.saa: VehicleGraphics2DSAA#

Get the satellite’s South Atlantic Anomaly Contour properties.

property SatelliteGraphics.range_contours: Graphics2DRangeContours#

Get the satellite’s Range Contours properties.

property SatelliteGraphics.lighting: VehicleGraphics2DLighting#

Get the satellite’s Lighting properties.

property SatelliteGraphics.swath: VehicleGraphics2DSwath#

Get the satellite’s Swath properties.

property SatelliteGraphics.ground_ellipses: VehicleGraphics2DGroundEllipsesCollection#

Get the satellite’s Ground Ellipses properties.

property SatelliteGraphics.label_notes: LabelNoteCollection#

Notes attached to the object and displayed in the 2D and 3D Graphics windows.

property SatelliteGraphics.ground_track_central_body_display: VehicleCentralBodies#

Get the ground track display central bodies.

property SatelliteGraphics.use_instance_name_label: bool#

Specify whether to use the name of the satellite (as shown in the Object Browser) as its label.

property SatelliteGraphics.label_name: str#

The user-specified name to use as a label for the satellite.

property SatelliteGraphics.show_graphics: bool#

Specify whether graphics attributes of the satellite are visible.

property SatelliteGraphics.radar_cross_section: RadarCrossSectionGraphics#

Get the radar cross section graphics interface.

Method detail#

SatelliteGraphics.set_attributes_type(self, attributes: VehicleGraphics2DAttributeType) None#

Set the attributes type.

Parameters:

attributes : VehicleGraphics2DAttributeType

Returns:

None

SatelliteGraphics.is_attributes_type_supported(self, attributes: VehicleGraphics2DAttributeType) bool#

Get a value indicating whether the specified type can be used.

Parameters:

attributes : VehicleGraphics2DAttributeType

Returns:

bool