org.jeometry.geom2D.point.Point2D Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jeometry-api Show documentation
Jeometry, a Mathematic and Geometry library for Java
There is a newer version: 1.0.5
package org.jeometry.geom2D.point;

import org.jeometry.Jeometry;
import org.jeometry.geom2D.SpatialLocalization2D;
import org.jeometry.math.Vector;

/**
 * This interface describes a point expressed within a two-dimensional Euclidean space.
 * The coordinates of the point (x, y) are expressed within a Cartesian coordinate system and are stored as double values.
 * @author Julien Seinturier - COMEX S.A. - [email protected] - https://github.com/jorigin/jeometry
 * @version {@value Jeometry#version}
 * @since 1.0.0
 */
public interface Point2D extends Coord2D, SpatialLocalization2D {

	/**
	 * The index of the dimension of the X coordinates.
	 * @see #DIMENSION_Y
	 */
	public static final int DIMENSION_X = 0;

	/**
	 * The index of the dimension of the Y coordinates.
	 * @see #DIMENSION_X
	 */
	public static final int DIMENSION_Y = 1;

	/**
	 * Get the point coordinate along the X axis.
	 * @return the point coordinate along the X axis.
	 * @see #getY()
	 * @see #setX(double)
	 */
	public double getX();

	/**
	 * Set the point coordinate along the X axis.
	 * @param x the point coordinate along the X axis.
	 * @see #setY(double)
	 * @see #getX()
	 */
	public void setX(double x);


	/**
	 * Get the point coordinate along the Y axis.
	 * @return the point coordinate along the Y axis.
	 * @see #getX()
	 * @see #setY(double)
	 */
	public double getY();

	/**
	 * Set the point coordinate along the Y axis.
	 * @param y the point coordinate along the Y axis.
	 * @see #setX(double)
	 * @see #getY()
	 */
	public void setY(double y);

	/**
	 * Set the coordinates values of this point according to the given ones.
	 * @param x the X coordinate
	 * @param y the Y coordinate
	 */
	public void setValues(double x, double y);

	/**
	 * Set this 2D point coordinates as a copy of those from the given 2D point.
	 * @param point the 2D point to copy
	 */
	public void setValues(Point2D point);

	@Override
	public Point2D plus(Vector v);

	@Override
	public Point2D plusAffect(Vector v);

	@Override
	public Point2D plus(double scalar);
	
	@Override
	public Point2D plusAffect(double scalar);
	
	@Override
	public Point2D minus(Vector v);

	@Override
	public Point2D minusAffect(Vector v);

	@Override
	public Point2D minus(double scalar);
	
	@Override
	public Point2D minusAffect(double scalar);
	
	@Override
	public Point2D multiply(double scalar);

	@Override
	public Point2D multiplyAffect(double scalar);

	@Override
	public Point2D multiply(Vector v);

	@Override
	public Point2D multiplyAffect(Vector v);

	@Override
	public Point2D divide(Vector v);

	@Override
	public Point2D divideAffect(Vector v);
	
	@Override
	public Point2D divide(double scalar);

	@Override
	public Point2D divideAffect(double scalar);
}