:orphan:

.. ****************************************************************************
.. CUI
..
.. The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
..
.. The use, dissemination or disclosure of data in this file is subject to
.. limitation or restriction. See accompanying README and LICENSE for details.
.. ****************************************************************************

WSF_HYBRID_MOVER
----------------

.. model:: mover WSF_HYBRID_MOVER

.. parsed-literal::

   mover :model:`WSF_HYBRID_MOVER`

      :ref:`Platform_Part_Commands` ...

      // `Mover Commands`_

      update_interval_ ...
      update_time_tolerance_ ...

      // `Hybrid Mover Commands`_

      follower_mover_ ...
      waypoint_mover_ ...
      current_mover_ ...
      auto_switch_

      ... Waypoint Mover Commands ...

      ... Follower Mover Commands ...

   end_mover

Overview
========

A specialized mover that consolidates the functionality of the WsfFollower mover and WsfWaypointMover mover.

.. block:: WSF_HYBRID_MOVER

Mover Commands
==============

.. command:: update_interval <time-value>
   
   If non-zero, specifies a periodic time interval at which the simulation will call the mover.  If zero then the mover
   will be called only when it is necessary to determine the position of the containing platform.
   
   Default: 0 seconds unless overridden by the specific mover implementation.

.. command:: update_time_tolerance <time-value>
   
   When a position update is requested by the simulation, if the time since the previous update is less than or equal to
   this value then the mover will ignore the update.
   
   Default: Most mover implementations define this as the time it takes to travel 1 meter at some nominal velocity that is
   appropriate for the implementation.

   .. note::
   
         A mover implementation may choose to ignore this command.

Hybrid Mover Commands
=====================

.. command:: follower_mover <name-value>
   
   The name of the predefined follower mover.

.. command:: waypoint_mover <name-value>
   
   The name of the predefined waypoint mover (i.e., :model:`WSF_AIR_MOVER`, :model:`WSF_GROUND_MOVER`, or
   :model:`WSF_SURFACE_MOVER`).

.. command:: current_mover [follower_mover | waypoint_mover]
   
   Sets the current mover to either the follower mover or the waypoint mover.

.. command:: auto_switch
   
   If the current mover is the follower and the lead no longer exists then switch back to the waypoint mover and return to
   the given route entering at the closest point.