Graphics2DRangeContours#

class ansys.stk.core.stkobjects.Graphics2DRangeContours#

Class defining 2D Graphics range contours: circles comprised of points at a given distance from an object and at the same altitude as that object.

Overview#

show_graphics

Display range contours representing the various regions of the surface that can see an object at the specified level.

show_filled_contours

Display the range contours as a filled polygon on the surface of the central body.

fill_style

Get or set the style in which the range contours polygon is filled. A member of the FillStyle enumeration.

level_attributes

The collection of level attributes defining the way in which the range contours are displayed.

number_of_decimal_digits

Number of decimal digits.

label_units

Get or set the display units on the 2d map.

available_label_units

Get the available units for the LabelUnit.

fill_translucency

Specify the fill translucency percentage of the polygon on the surface of the central body. Translucency ranges from 0 to 100 percent, where 100 percent is invisible.

Examples#

Set 2D/3D Range Contours

# Satellite satellite: Satellite object
# Set a contour level in the 2D properties
rangeContours = satellite.graphics.range_contours
rangeContours.show_graphics = True
rangeLevel = rangeContours.level_attributes.add_level(2000)  # km
rangeLevel.color = Colors.Fuchsia
rangeLevel.line_width = LineWidth.WIDTH5
rangeLevel.label_angle = 90
rangeLevel.show_user_text_visible = True
rangeLevel.user_text = "Range"
# Turn the contours on in the 3D properties
satellite.graphics_3d.range_contours.show_graphics = True

Import detail#

from ansys.stk.core.stkobjects import Graphics2DRangeContours

Property detail#

property Graphics2DRangeContours.show_graphics: bool#

Display range contours representing the various regions of the surface that can see an object at the specified level.

property Graphics2DRangeContours.show_filled_contours: bool#

Display the range contours as a filled polygon on the surface of the central body.

property Graphics2DRangeContours.fill_style: FillStyle#

Get or set the style in which the range contours polygon is filled. A member of the FillStyle enumeration.

property Graphics2DRangeContours.level_attributes: LevelAttributeCollection#

The collection of level attributes defining the way in which the range contours are displayed.

property Graphics2DRangeContours.number_of_decimal_digits: int#

Number of decimal digits.

property Graphics2DRangeContours.label_units: str#

Get or set the display units on the 2d map.

property Graphics2DRangeContours.available_label_units: list#

Get the available units for the LabelUnit.

property Graphics2DRangeContours.fill_translucency: float#

Specify the fill translucency percentage of the polygon on the surface of the central body. Translucency ranges from 0 to 100 percent, where 100 percent is invisible.