PlanetGraphics#

class ansys.stk.core.stkobjects.PlanetGraphics#

Class defining 2D Graphics properties of a Planet.

Overview#

inherit

Specify whether inheritable 2D Graphics attributes are inherited from Scenario-level settings.

color

The color in which the planet’s marker, label and orbit path (if any) are displayed.

show_sub_planet_label

Specify whether a label displays for the point on the Earth directly below the planet.

show_position_label

Specify whether a label displays for the inertial position of the planet. This option affects only the perspective and orthographic map projections.

marker_style

The style of the marker representing the planet.

show_inertial_position

Specify whether the position of the planet displays in the 2D Graphics window in the Central-Body Inertial (CBI) coordinate frame. This option affects only the perspective and orthographic map projections.

show_sub_planet_point

Specify whether the point on the Earth directly below the planet displays in the 2D Graphics window.

show_orbit

Specify whether the planet’s orbit path displays. This option affects only the perspective and orthographic map projections.

orbit_display

The factor used in determining how much of the orbit displays. A member of the PlanetOrbitDisplayType enumeration.

orbit_display_data

If time is used to determine how much of the orbit displays, specify a time value.

line_style

The type of line to represent the object’s pattern or tracks.

line_width

The width of the line to represent the object’s pattern or tracks.

show_graphics

Specify whether graphics attributes of the planet are visible.

Import detail#

from ansys.stk.core.stkobjects import PlanetGraphics

Property detail#

property PlanetGraphics.inherit: bool#

Specify whether inheritable 2D Graphics attributes are inherited from Scenario-level settings.

property PlanetGraphics.color: Color#

The color in which the planet’s marker, label and orbit path (if any) are displayed.

property PlanetGraphics.show_sub_planet_label: bool#

Specify whether a label displays for the point on the Earth directly below the planet.

property PlanetGraphics.show_position_label: bool#

Specify whether a label displays for the inertial position of the planet. This option affects only the perspective and orthographic map projections.

property PlanetGraphics.marker_style: str#

The style of the marker representing the planet.

property PlanetGraphics.show_inertial_position: bool#

Specify whether the position of the planet displays in the 2D Graphics window in the Central-Body Inertial (CBI) coordinate frame. This option affects only the perspective and orthographic map projections.

property PlanetGraphics.show_sub_planet_point: bool#

Specify whether the point on the Earth directly below the planet displays in the 2D Graphics window.

property PlanetGraphics.show_orbit: bool#

Specify whether the planet’s orbit path displays. This option affects only the perspective and orthographic map projections.

property PlanetGraphics.orbit_display: PlanetOrbitDisplayType#

The factor used in determining how much of the orbit displays. A member of the PlanetOrbitDisplayType enumeration.

property PlanetGraphics.orbit_display_data: IOrbitDisplayData#

If time is used to determine how much of the orbit displays, specify a time value.

property PlanetGraphics.line_style: LineStyle#

The type of line to represent the object’s pattern or tracks.

property PlanetGraphics.line_width: LineWidth#

The width of the line to represent the object’s pattern or tracks.

property PlanetGraphics.show_graphics: bool#

Specify whether graphics attributes of the planet are visible.