/*
* $Id$
* This file is a part of the Arakhne Foundation Classes, http://www.arakhne.org/afc
*
* Copyright (c) 2000-2012 Stephane GALLAND.
* Copyright (c) 2005-10, Multiagent Team, Laboratoire Systemes et Transports,
* Universite de Technologie de Belfort-Montbeliard.
* Copyright (c) 2013-2016 The original authors, and other authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.arakhne.afc.agentmotion;
import org.eclipse.xtext.xbase.lib.Pure;
import org.arakhne.afc.math.geometry.d2.Point2D;
import org.arakhne.afc.math.geometry.d2.Vector2D;
/** Agent is changing its orientation for facing the target point.
*
* @author $Author: sgalland$
* @version $FullVersion$
* @mavengroupid $GroupId$
* @mavenartifactid $ArtifactId$
* @since 14.0
*/
public interface FacingMotionAlgorithm {
/** Clone this algorithm.
*
* @return the clone.
*/
@Pure
FacingMotionAlgorithm clone();
/** Calculate the rotation for facing the target point.
*
* @param position is the current position of the entity.
* @param orientation is the current orientation of the entity.
* @param angularSpeed is the current angular speed of the entity.
* @param maxAngular is the maximal angular speed or acceleration of the entity.
* @param target is the point to face to.
* @return the agent motion.
*/
@Pure
double calculate(Point2D<?, ?> position, Vector2D<?, ?> orientation, double angularSpeed,
double maxAngular, Point2D<?, ?> target);
}