Navigation
==========

.. contents:: Table of Contents
   :depth: 2
   :local:
   :backlinks: none


TODO: Short description of core modules and overall process, identical to the dev guide, probably refer the dev guide
back here and then add extra notes


Core
----

.. automodule:: dronemanager.navigation.core
   :members:
   :undoc-members:
   :show-inheritance:


Path Generators
---------------

.. automodule:: dronemanager.navigation.directtargetgenerator
   :members:
   :undoc-members:
   :show-inheritance:


GMP3
^^^^

.. automodule:: dronemanager.navigation.gmp3generator
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: dronemanager.navigation.GMP3
   :members:
   :undoc-members:
   :show-inheritance:


Path Followers
--------------

.. automodule:: dronemanager.navigation.directsetpointfollower
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: dronemanager.navigation.ruckigfollower
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: dronemanager.navigation.velocityfollower
   :members:
   :undoc-members:
   :show-inheritance:


Fences
------

TODO: Short guide on the various geometries.
Fence limits, fence limits with drone size accounted for, extra safety margin based on safety level
Key functions: "display boundary", "stick safety"

.. automodule:: dronemanager.navigation.rectlocalfence
   :members:
   :undoc-members:
   :show-inheritance: