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

OrbitPath
=========


.. class:: OrbitPath

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

   .. attribute:: orbit: SpaceCenter.Orbit

      The orbit.

      :Attribute: Can be read or written
      :rtype: :class:`SpaceCenter.Orbit`

   .. attribute:: whole_orbit: boolean

      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:`Drawing.OrbitPath.start_true_anomaly`
      to :attr:`Drawing.OrbitPath.end_true_anomaly`.

      :Attribute: Can be read or written
      :rtype: boolean

   .. attribute:: start_true_anomaly: number

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

      :Attribute: Can be read or written
      :rtype: number

      .. note::

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

   .. attribute:: end_true_anomaly: number

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

      :Attribute: Can be read or written
      :rtype: number

      .. note::

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

   .. attribute:: visible: boolean

      Whether the object is visible.

      :Attribute: Can be read or written
      :rtype: boolean

   .. attribute:: color: StdLib.ColorRGB

      The color of the path.

      :Attribute: Can be read or written
      :rtype: :class:`StdLib.ColorRGB`

      .. note::

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

   .. attribute:: colors: List

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

      :Attribute: Can be read or written
      :rtype: List

      .. note::

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

   .. attribute:: thickness: number

      The thickness of the path.

      :Attribute: Can be read or written
      :rtype: number

   .. attribute:: start_arrow: boolean

      Whether an arrow head is drawn at the start.

      :Attribute: Can be read or written
      :rtype: boolean

   .. attribute:: end_arrow: boolean

      Whether an arrow head is drawn at the end.

      :Attribute: Can be read or written
      :rtype: boolean

   .. attribute:: arrow_size: number

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

      :Attribute: Can be read or written
      :rtype: number

   .. attribute:: dashed: boolean

      Whether the path is drawn as a dashed line.

      :Attribute: Can be read or written
      :rtype: boolean

   .. attribute:: label: string

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

      :Attribute: Can be read or written
      :rtype: string

   .. attribute:: material: string

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

      :Attribute: Can be read or written
      :rtype: string

   .. method:: remove()

      Remove the object.