SatelliteGraphics ================= .. py:class:: ansys.stk.core.stkobjects.SatelliteGraphics Satellite 2D Graphics properties. .. py:currentmodule:: SatelliteGraphics Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.set_attributes_type` - Set the attributes type. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.is_attributes_type_supported` - Get a value indicating whether the specified type can be used. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.attributes_type` - Type of 2D Graphics attributes: basic, access intervals or custom intervals. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.attributes_supported_types` - Return an array of valid choices. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.attributes` - Get the satellite's 2D Graphics Attributes. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.time_events` - Get the satellite's TimeEvents properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.passes` - Get the pass display settings of the satellite's Pass properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.pass_data` - Get the leading/trailing ground track and orbit settings of the satellite's Pass properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.resolution` - Get the path resolution settings of the satellite's Pass properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.elevation_contours` - Get the satellite's Elevation Contours properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.saa` - Get the satellite's South Atlantic Anomaly Contour properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.range_contours` - Get the satellite's Range Contours properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.lighting` - Get the satellite's Lighting properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.swath` - Get the satellite's Swath properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.ground_ellipses` - Get the satellite's Ground Ellipses properties. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.label_notes` - Notes attached to the object and displayed in the 2D and 3D Graphics windows. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.ground_track_central_body_display` - Get the ground track display central bodies. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.use_instance_name_label` - Specify whether to use the name of the satellite (as shown in the Object Browser) as its label. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.label_name` - The user-specified name to use as a label for the satellite. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.show_graphics` - Specify whether graphics attributes of the satellite are visible. * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteGraphics.radar_cross_section` - Get the radar cross section graphics interface. Examples -------- Change the Display Label of the vehicle .. code-block:: python # Satellite satellite: Satellite object satellite.graphics.use_instance_name_label = False satellite.graphics.label_name = "Python Satellite" Import detail ------------- .. code-block:: python from ansys.stk.core.stkobjects import SatelliteGraphics Property detail --------------- .. py:property:: attributes_type :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.attributes_type :type: VehicleGraphics2DAttributeType Type of 2D Graphics attributes: basic, access intervals or custom intervals. .. py:property:: attributes_supported_types :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.attributes_supported_types :type: list Return an array of valid choices. .. py:property:: attributes :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.attributes :type: IVehicleGraphics2DAttributes Get the satellite's 2D Graphics Attributes. .. py:property:: time_events :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.time_events :type: VehicleGraphics2DTimeEventsCollection Get the satellite's TimeEvents properties. .. py:property:: passes :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.passes :type: VehicleGraphics2DPasses Get the pass display settings of the satellite's Pass properties. .. py:property:: pass_data :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.pass_data :type: VehicleGraphics2DOrbitPassData Get the leading/trailing ground track and orbit settings of the satellite's Pass properties. .. py:property:: resolution :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.resolution :type: VehicleGraphics2DPassResolution Get the path resolution settings of the satellite's Pass properties. .. py:property:: elevation_contours :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.elevation_contours :type: VehicleGraphics2DElevationContours Get the satellite's Elevation Contours properties. .. py:property:: saa :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.saa :type: VehicleGraphics2DSAA Get the satellite's South Atlantic Anomaly Contour properties. .. py:property:: range_contours :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.range_contours :type: Graphics2DRangeContours Get the satellite's Range Contours properties. .. py:property:: lighting :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.lighting :type: VehicleGraphics2DLighting Get the satellite's Lighting properties. .. py:property:: swath :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.swath :type: VehicleGraphics2DSwath Get the satellite's Swath properties. .. py:property:: ground_ellipses :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.ground_ellipses :type: VehicleGraphics2DGroundEllipsesCollection Get the satellite's Ground Ellipses properties. .. py:property:: label_notes :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.label_notes :type: LabelNoteCollection Notes attached to the object and displayed in the 2D and 3D Graphics windows. .. py:property:: ground_track_central_body_display :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.ground_track_central_body_display :type: VehicleCentralBodies Get the ground track display central bodies. .. py:property:: use_instance_name_label :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.use_instance_name_label :type: bool Specify whether to use the name of the satellite (as shown in the Object Browser) as its label. .. py:property:: label_name :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.label_name :type: str The user-specified name to use as a label for the satellite. .. py:property:: show_graphics :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.show_graphics :type: bool Specify whether graphics attributes of the satellite are visible. .. py:property:: radar_cross_section :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.radar_cross_section :type: RadarCrossSectionGraphics Get the radar cross section graphics interface. Method detail ------------- .. py:method:: set_attributes_type(self, attributes: VehicleGraphics2DAttributeType) -> None :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.set_attributes_type Set the attributes type. :Parameters: **attributes** : :obj:`~VehicleGraphics2DAttributeType` :Returns: :obj:`~None` .. py:method:: is_attributes_type_supported(self, attributes: VehicleGraphics2DAttributeType) -> bool :canonical: ansys.stk.core.stkobjects.SatelliteGraphics.is_attributes_type_supported Get a value indicating whether the specified type can be used. :Parameters: **attributes** : :obj:`~VehicleGraphics2DAttributeType` :Returns: :obj:`~bool`