VehicleGraphics2DPasses#

class ansys.stk.core.stkobjects.VehicleGraphics2DPasses#

Settings for satellite pass display graphics.

Overview#

set_pass_type

Pass display option: show all or those in a user-specified range.

is_pass_type_supported

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

pass_type

Pass display option: show all or those in a user-specified range.

pass_supported_types

Return an array of valid choices.

satellite_pass

Get the pass property.

visible_sides

Get or set the visible sides option for the pass: ascending, descending, both or none.

show_pass_labels

Opt whether to display pass numbers at the pass break locations in the 2D Graphics window.

show_path_labels

Opt whether to display path numbers within a repeating ground track sequence at the pass break locations in the 2D Graphics window.

Import detail#

from ansys.stk.core.stkobjects import VehicleGraphics2DPasses

Property detail#

property VehicleGraphics2DPasses.pass_type: VehicleGraphics2DPass#

Pass display option: show all or those in a user-specified range.

property VehicleGraphics2DPasses.pass_supported_types: list#

Return an array of valid choices.

property VehicleGraphics2DPasses.satellite_pass: IVehicleGraphics2DPass#

Get the pass property.

property VehicleGraphics2DPasses.visible_sides: VehicleGraphics2DVisibleSideType#

Get or set the visible sides option for the pass: ascending, descending, both or none.

property VehicleGraphics2DPasses.show_pass_labels: bool#

Opt whether to display pass numbers at the pass break locations in the 2D Graphics window.

property VehicleGraphics2DPasses.show_path_labels: bool#

Opt whether to display path numbers within a repeating ground track sequence at the pass break locations in the 2D Graphics window.

Method detail#

VehicleGraphics2DPasses.set_pass_type(self, pass_type: VehicleGraphics2DPass) None#

Pass display option: show all or those in a user-specified range.

Parameters:

pass_type : VehicleGraphics2DPass

Returns:

None

VehicleGraphics2DPasses.is_pass_type_supported(self, pass_type: VehicleGraphics2DPass) bool#

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

Parameters:

pass_type : VehicleGraphics2DPass

Returns:

bool