VehicleGraphics3DLeadTrailData

class ansys.stk.core.stkobjects.VehicleGraphics3DLeadTrailData

LaunchVehicleGraphics3DTrajectory2 Class.

Overview

Methods

set_lead_data_type	Set the display option for the leading portion of the vehicle’s tracks.
set_trail_data_type	Set the display option for the trailng portion of the vehicle’s tracks.
is_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	Get display option for the leading portion of the vehicle’s tracks.
trail_data_type	Get display option for the trailing portion of the vehicle’s tracks.
lead_data	Get the display value (time or percent) for the leading portion of the vehicle’s tracks.
trail_data	Get the display value (time or percent) for the trailing portion of the vehicle’s tracks.
has_lead_data	Determine whether the leading display option has value data.
has_trail_data	Determine whether the trailing display option has value data.
supported_data_types	Return an array of valid choices.

Import detail

from ansys.stk.core.stkobjects import VehicleGraphics3DLeadTrailData

Property detail

property VehicleGraphics3DLeadTrailData.lead_data_type: LeadTrailData

Get display option for the leading portion of the vehicle’s tracks.

property VehicleGraphics3DLeadTrailData.trail_data_type: LeadTrailData

Get display option for the trailing portion of the vehicle’s tracks.

property VehicleGraphics3DLeadTrailData.lead_data: IVehicleLeadTrailData

Get the display value (time or percent) for the leading portion of the vehicle’s tracks.

property VehicleGraphics3DLeadTrailData.trail_data: IVehicleLeadTrailData

Get the display value (time or percent) for the trailing portion of the vehicle’s tracks.

property VehicleGraphics3DLeadTrailData.has_lead_data: bool

Determine whether the leading display option has value data.

property VehicleGraphics3DLeadTrailData.has_trail_data: bool

Determine whether the trailing display option has value data.

property VehicleGraphics3DLeadTrailData.supported_data_types: list

Return an array of valid choices.

Method detail

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

Set the display option for the leading portion of the vehicle’s tracks.

Parameters:

lead_data : LeadTrailData

Returns:

None

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

Set the display option for the trailng portion of the vehicle’s tracks.

Parameters:

trail_data : LeadTrailData

Returns:

None

VehicleGraphics3DLeadTrailData.is_data_type_supported(self, data: LeadTrailData) → bool

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

Parameters:

data : LeadTrailData

Returns:

bool

VehicleGraphics3DLeadTrailData.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