/*
 * $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.math.geometry.d3;

/** Factory of geometrical primitives.
 *
 * @param <V> the types of the vectors.
 * @param <P> is the type of the points.
 * @author $Author: tpiotrow$
 * @author $Author: sgalland$
 * @version $FullVersion$
 * @mavengroupid $GroupId$
 * @mavenartifactid $ArtifactId$
 */
public interface GeomFactory3D<V extends Vector3D<? super V, ? super P>, P extends Point3D<? super P, ? super V>> {

	/** Convert the given point if it is not of the right type.
	 *
	 * @param point the point to convert.
	 * @return <code>p</code> if it is of type <code>P</code>, or a copy of <code>p</code>.
	 */
	P convertToPoint(Point3D<?, ?> point);

	/** Convert the given vector.
	 *
	 * @param vector the vector to convert.
	 * @return the point.
	 */
	P convertToPoint(Vector3D<?, ?> vector);

	/** Convert the given point.
	 *
	 * @param point the point to convert.
	 * @return the vector.
	 */
	V convertToVector(Point3D<?, ?> point);

	/** Convert the given vector.
	 *
	 * @param vector the vector to convert.
	 * @return the vector.
	 */
	V convertToVector(Vector3D<?, ?> vector);

	/** Create a point.
	 *
	 * @return the point.
	 */
	P newPoint();

	/** Create a point.
	 *
	 * @param x x coordinate of the point.
	 * @param y y coordinate of the point.
	 * @param z z coordinate of the point.
	 * @return the point.
	 */
	P newPoint(double x, double y, double z);

	/** Create a point.
	 *
	 * @param x x coordinate of the point.
     * @param y y coordinate of the point.
     * @param z z coordinate of the point.
	 * @return the point.
	 */
	P newPoint(int x, int y, int z);

	/** Create a vector.
	 *
	 * @return the vector.
	 */
	V newVector();

	/** Create a vector.
	 *
     * @param x x coordinate of the vector.
     * @param y y coordinate of the vector.
     * @param z z coordinate of the vector.
	 * @return the vector.
	 */
	V newVector(double x, double y, double z);

	/** Create a vector.
	 *
	 * @param x x coordinate of the vector.
     * @param y y coordinate of the vector.
     * @param z z coordinate of the vector.
	 * @return the vector.
	 */
	V newVector(int x, int y, int z);

	/** Creates a Quaternion.
	 *
	 * @param axis the axis of the quaternion.
	 * @param angle the angle of the quaternion.
	 * @return the quaternion.
	 */
	Quaternion newQuaternion(Vector3D<?, ?> axis, double angle);

	/**Creates a Quaternion.
	 *
	 * @param attitude the attitude of the quaternion
	 * @param bank the bank of the quaternion
	 * @param heading the heading of the quaternion
	 * @return the quaternion
	 */
	Quaternion newQuaternion(double attitude, double bank, double heading);
}