IGreatArcGraphics#

class ansys.stk.core.stkobjects.IGreatArcGraphics#

2D Graphics common for all Great Arc Vehicles.

Overview#

set_attributes_type

Set the 2D Graphics attributes type for the vehicle.

is_attributes_type_supported

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

attributes_type

Get the 2D Graphics attributes type for the vehicle: basic, access intervals, custom intervals, or real time.

attributes_supported_types

Return an array of valid choices.

attributes

Get the vehicle’s 2D Graphics attributes.

pass_data

Get the vehicle’s 2D route graphics.

waypoint_marker

Get the vehicle’s 2D waypoint marker graphics.

resolution

Get the vehicle’s 2D resolution graphics.

range_contours

Get the vehicle’s 2D range contour graphics.

lighting

Get the vehicle’s 2D lighting graphics.

ground_ellipses

Get the vehicle’s 2D ground ellipses graphics.

label_notes

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

use_instance_name_label

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

label_name

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

show_graphics

Specify whether graphics attributes of the vehicle are visible.

Import detail#

from ansys.stk.core.stkobjects import IGreatArcGraphics

Property detail#

property IGreatArcGraphics.attributes_type: VehicleGraphics2DAttributeType#

Get the 2D Graphics attributes type for the vehicle: basic, access intervals, custom intervals, or real time.

property IGreatArcGraphics.attributes_supported_types: list#

Return an array of valid choices.

property IGreatArcGraphics.attributes: IVehicleGraphics2DAttributes#

Get the vehicle’s 2D Graphics attributes.

property IGreatArcGraphics.pass_data: VehicleGraphics2DRoutePassData#

Get the vehicle’s 2D route graphics.

property IGreatArcGraphics.waypoint_marker: VehicleGraphics2DWaypointMarker#

Get the vehicle’s 2D waypoint marker graphics.

property IGreatArcGraphics.resolution: VehicleGraphics2DRouteResolution#

Get the vehicle’s 2D resolution graphics.

property IGreatArcGraphics.range_contours: Graphics2DRangeContours#

Get the vehicle’s 2D range contour graphics.

property IGreatArcGraphics.lighting: VehicleGraphics2DLighting#

Get the vehicle’s 2D lighting graphics.

property IGreatArcGraphics.ground_ellipses: VehicleGraphics2DGroundEllipsesCollection#

Get the vehicle’s 2D ground ellipses graphics.

property IGreatArcGraphics.label_notes: LabelNoteCollection#

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

property IGreatArcGraphics.use_instance_name_label: bool#

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

property IGreatArcGraphics.label_name: str#

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

property IGreatArcGraphics.show_graphics: bool#

Specify whether graphics attributes of the vehicle are visible.

Method detail#

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

Set the 2D Graphics attributes type for the vehicle.

Parameters:

attributes : VehicleGraphics2DAttributeType

Returns:

None

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

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

Parameters:

attributes : VehicleGraphics2DAttributeType

Returns:

bool