VehicleGraphics2DLeadTrailData

class ansys.stk.core.stkobjects.VehicleGraphics2DLeadTrailData

2D Graphics pass properties: lead/trail for ground tracks.

Overview

Methods

set_lead_data_type	Lead data type.
is_lead_data_type_supported	Get a value indicating whether the specified type can be used.
set_trail_data_type	Trail data type.
is_trail_data_type_supported	Get a value indicating whether the specified type can be used.
set_trail_same_as_lead	Set the trailing display option (and value, if applicable) to be the same as for the leading portion.

Properties

lead_data_type	Lead data type.
lead_data_supported_types	Return an array of valid choices.
lead_data	Lead data.
trail_data_type	Trail data type.
trail_data_supported_types	Return an array of valid choices.
trail_data	Trail data.
has_lead_data	Determine whether the leading display option has value data.
has_trail_data	Determine whether the trailing display option has value data.

Import detail

from ansys.stk.core.stkobjects import VehicleGraphics2DLeadTrailData

Property detail

property VehicleGraphics2DLeadTrailData.lead_data_type: LeadTrailData

Lead data type.

property VehicleGraphics2DLeadTrailData.lead_data_supported_types: list

Return an array of valid choices.

property VehicleGraphics2DLeadTrailData.lead_data: IVehicleLeadTrailData

Lead data.

property VehicleGraphics2DLeadTrailData.trail_data_type: LeadTrailData

Trail data type.

property VehicleGraphics2DLeadTrailData.trail_data_supported_types: list

Return an array of valid choices.

property VehicleGraphics2DLeadTrailData.trail_data: IVehicleLeadTrailData

Trail data.

property VehicleGraphics2DLeadTrailData.has_lead_data: bool

Determine whether the leading display option has value data.

property VehicleGraphics2DLeadTrailData.has_trail_data: bool

Determine whether the trailing display option has value data.

Method detail

VehicleGraphics2DLeadTrailData.set_lead_data_type(self, lead_data: LeadTrailData) → None

Lead data type.

Parameters:

lead_data : LeadTrailData

Returns:

None

VehicleGraphics2DLeadTrailData.is_lead_data_type_supported(self, lead_data: LeadTrailData) → bool

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

Parameters:

lead_data : LeadTrailData

Returns:

bool

VehicleGraphics2DLeadTrailData.set_trail_data_type(self, trail_data: LeadTrailData) → None

Trail data type.

Parameters:

trail_data : LeadTrailData

Returns:

None

VehicleGraphics2DLeadTrailData.is_trail_data_type_supported(self, trail_data: LeadTrailData) → bool

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

Parameters:

trail_data : LeadTrailData

Returns:

bool

VehicleGraphics2DLeadTrailData.set_trail_same_as_lead(self) → None

Set the trailing display option (and value, if applicable) to be the same as for the leading portion.

Returns:

None