VehicleGraphics2DSwath

class ansys.stk.core.stkobjects.VehicleGraphics2DSwath

Vehicle swath.

Overview

Methods

set_elevation_type	Set the elevation type.
is_elevation_type_supported	Get a value indicating whether the specified type can be used.

Properties

elevation_type	Ground elevation, swath half width or vehicle half angle.
elevation_supported_types	Return an array of valid choices.
elevation	Get the elevation value.
options	Options for swath display.

Examples

Set 2D Swath

# Satellite satellite: Satellite object
# Set swath in the 2D properties
swath = satellite.graphics.swath
swath.set_elevation_type(VehicleGraphics2DElevation.ELEVATION_GROUND_ELEVATION)
swath.elevation.angle = 30  # deg
satellite.graphics.swath.options = VehicleGraphics2DOptionType.OPTIONS_EDGE_LIMITS

Import detail

from ansys.stk.core.stkobjects import VehicleGraphics2DSwath

Property detail

property VehicleGraphics2DSwath.elevation_type: VehicleGraphics2DElevation

Ground elevation, swath half width or vehicle half angle.

property VehicleGraphics2DSwath.elevation_supported_types: list

Return an array of valid choices.

property VehicleGraphics2DSwath.elevation: IVehicleGraphics2DElevation

Get the elevation value.

property VehicleGraphics2DSwath.options: VehicleGraphics2DOptionType

Options for swath display.

Method detail

VehicleGraphics2DSwath.set_elevation_type(self, elevation: VehicleGraphics2DElevation) → None

Set the elevation type.

Parameters:

elevation : VehicleGraphics2DElevation

Returns:

None

VehicleGraphics2DSwath.is_elevation_type_supported(self, elevation: VehicleGraphics2DElevation) → bool

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

Parameters:

elevation : VehicleGraphics2DElevation

Returns:

bool