.. default-domain:: cpp
.. highlight:: cpp
.. namespace:: krpc::services::Drawing

OrbitPath
=========


.. class:: OrbitPath

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

   .. function:: SpaceCenter::Orbit orbit()
   .. function:: void set_orbit(SpaceCenter::Orbit value)

      The orbit.

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

   .. function:: bool whole_orbit()
   .. function:: void set_whole_orbit(bool value)

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

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

   .. function:: double start_true_anomaly()
   .. function:: void set_start_true_anomaly(double value)

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

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


      .. note::

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

   .. function:: double end_true_anomaly()
   .. function:: void set_end_true_anomaly(double value)

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

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


      .. note::

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

   .. function:: bool visible()
   .. function:: void set_visible(bool value)

      Whether the object is visible.

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

   .. function:: StdLib::ColorRGB color()
   .. function:: void set_color(StdLib::ColorRGB value)

      The color of the path.

      :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.

   .. function:: std::vector<StdLib::ColorRGB> colors()
   .. function:: void set_colors(std::vector<StdLib::ColorRGB> value)

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

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


      .. note::

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

   .. function:: float thickness()
   .. function:: void set_thickness(float value)

      The thickness of the path.

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

   .. function:: bool start_arrow()
   .. function:: void set_start_arrow(bool value)

      Whether an arrow head is drawn at the start.

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

   .. function:: bool end_arrow()
   .. function:: void set_end_arrow(bool value)

      Whether an arrow head is drawn at the end.

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

   .. function:: float arrow_size()
   .. function:: void set_arrow_size(float value)

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

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

   .. function:: bool dashed()
   .. function:: void set_dashed(bool value)

      Whether the path is drawn as a dashed line.

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

   .. function:: std::string label()
   .. function:: void set_label(std::string value)

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

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

   .. function:: std::string material()
   .. function:: void set_material(std::string value)

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

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

   .. function:: void remove()

      Remove the object.


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