using System;

using UnityEngine;

namespace Framework.Actors {

  // CHECK: Rename this to IMoving, IPhysicsBody, INewtonian?

  /// <summary>Gives the velocity of a game object which is not a rigid body</summary>
  /// <remarks>
  ///   <para>
  ///     In some games it may be necessary for actors to stand on moving objects,
  ///     be it elevators, floating platforms or cars. These are often controlled by
  ///     a fixed path rather than via rigid body physics.
  ///   </para>
  ///   <para>
  ///     The <see cref="IVelocityProvider" /> interface gives the actor framework
  ///     a chance to determine the velocity of the ground an actor is standing on,
  ///     no matter how the ground is being moved. Simply write a &quot;glue&quot;
  ///     component that implements this interface and delivers the velocity of
  ///     the game object it is added to.
  ///   </para>
  /// </remarks>
  public interface IVelocityProvider {

    /// <summary>Current velocity of the game object</summary>
    Vector3 Velocity { get; }

  }

} // namespace Framework.Actors