.. default-domain:: py
.. highlight:: py
.. currentmodule:: Drawing

OrbitPath
=========


.. class:: OrbitPath

   The path of an orbit. Created using :meth:`add_orbit`.

   .. attribute:: orbit

      The orbit.

      :Attribute: Can be read or written
      :rtype: :class:`SpaceCenter.Orbit`
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: whole_orbit

      Whether the whole orbit is drawn, up to where it leaves the sphere of influence of
      its body. When false, the orbit is drawn from :attr:`OrbitPath.start_true_anomaly`
      to :attr:`OrbitPath.end_true_anomaly`.

      :Attribute: Can be read or written
      :rtype: bool
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: start_true_anomaly

      The true anomaly at which the path starts, in radians.

      :Attribute: Can be read or written
      :rtype: float
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph


      .. note::

         Setting this sets :attr:`OrbitPath.whole_orbit` to false.

   .. attribute:: end_true_anomaly

      The true anomaly at which the path ends, in radians.

      :Attribute: Can be read or written
      :rtype: float
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph


      .. note::

         Setting this sets :attr:`OrbitPath.whole_orbit` to false.

   .. attribute:: visible

      Whether the object is visible.

      :Attribute: Can be read or written
      :rtype: bool
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: color

      The color of the path.

      :Attribute: Can be read or written
      :rtype: :class:`StdLib.ColorRGB`
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph


      .. note::

         For a path drawn with more than one color, this is the color at its start.

   .. attribute:: colors

      The colors of the path, blended evenly from its start to its end.

      :Attribute: Can be read or written
      :rtype: list(:class:`StdLib.ColorRGB`)
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph


      .. note::

         Throws an exception if the list is empty or holds more than 8 colors.

   .. attribute:: thickness

      The thickness of the path.

      :Attribute: Can be read or written
      :rtype: float
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: start_arrow

      Whether an arrow head is drawn at the start.

      :Attribute: Can be read or written
      :rtype: bool
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: end_arrow

      Whether an arrow head is drawn at the end.

      :Attribute: Can be read or written
      :rtype: bool
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: arrow_size

      The size of the arrow heads, relative to the thickness.

      :Attribute: Can be read or written
      :rtype: float
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: dashed

      Whether the path is drawn as a dashed line.

      :Attribute: Can be read or written
      :rtype: bool
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: label

      Text drawn halfway along the path, facing the camera. Empty for no label.

      :Attribute: Can be read or written
      :rtype: str
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. attribute:: material

      Material used to render the object.
      Creates the material from a shader with the given name.

      :Attribute: Can be read or written
      :rtype: str
      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph

   .. method:: remove()

      Remove the object.

      :Game Scenes: Flight, Tracking Station, Editor Vab, Editor Sph