.. default-domain:: java
.. highlight:: java
.. package:: krpc.client.services.Drawing

OrbitPath
=========


.. type:: public class OrbitPath

   The path of an orbit. Created using :meth:`addOrbit(SpaceCenter.Orbit, boolean)`.

   .. method:: SpaceCenter.Orbit getOrbit()

   .. method:: void setOrbit(SpaceCenter.Orbit value)

      The orbit.

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

   .. method:: boolean getWholeOrbit()

   .. method:: void setWholeOrbit(boolean 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 :meth:`OrbitPath.getStartTrueAnomaly()`
      to :meth:`OrbitPath.getEndTrueAnomaly()`.

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

   .. method:: double getStartTrueAnomaly()

   .. method:: void setStartTrueAnomaly(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 :meth:`OrbitPath.getWholeOrbit()` to false.

   .. method:: double getEndTrueAnomaly()

   .. method:: void setEndTrueAnomaly(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 :meth:`OrbitPath.getWholeOrbit()` to false.

   .. method:: boolean getVisible()

   .. method:: void setVisible(boolean value)

      Whether the object is visible.

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

   .. method:: StdLib.ColorRGB getColor()

   .. method:: void setColor(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.

   .. method:: java.util.List<StdLib.ColorRGB> getColors()

   .. method:: void setColors(java.util.List<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.

   .. method:: float getThickness()

   .. method:: void setThickness(float value)

      The thickness of the path.

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

   .. method:: boolean getStartArrow()

   .. method:: void setStartArrow(boolean value)

      Whether an arrow head is drawn at the start.

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

   .. method:: boolean getEndArrow()

   .. method:: void setEndArrow(boolean value)

      Whether an arrow head is drawn at the end.

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

   .. method:: float getArrowSize()

   .. method:: void setArrowSize(float value)

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

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

   .. method:: boolean getDashed()

   .. method:: void setDashed(boolean value)

      Whether the path is drawn as a dashed line.

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

   .. method:: String getLabel()

   .. method:: void setLabel(String value)

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

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

   .. method:: String getMaterial()

   .. method:: void setMaterial(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

   .. method:: void remove()

      Remove the object.

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