Application: gvSIG desktop » Library: org.gvsig.tools

/*

 * To change this license header, choose License Headers in Project Properties.

 * To change this template file, choose Tools | Templates

 * and open the template in the editor.

 */

package org.gvsig.euclidean;

import java.awt.geom.Point2D;

/**

 *

 * @author fdiaz

 */

public interface EuclideanLine2D {

    /**

     * Return coeficient A of general equation (Ax + By + C=0).

     * 

     * @return A

     */

    public double getA();

    /**

     * Return coeficient B of general equation (Ax + By + C=0).

     *

     * @return B

     */

    public double getB();

    /**

     * Return coeficient C of general equation (Ax + By + C=0).

     * 

     * @return C

     */

    public double getC();

    /**

     * Return de slope (m in explicit equation of the line y=m+x+b)

     * 

     * @return m

     */

    public double getSlope();

    /**

     * Return de Y-intercept (b in explicit equation of the line y=m+x+b)

     *

     * @return b

     */

    public double getYIntercept();

    /**

     * Returns the y coordinate of a point on the line whose x coordinate is the value of the parameter

     * 

     * @param x

     * @return y

     */

    public double getY(double x);

    /**

     * Returns the x coordinate of a point on the line whose y coordinate is the value of the parameter

     * 

     * @param y

     * @return x

     */

    public double getX(double y);

    /**

     * Returns the minor angle in radians between this line and the line parameter

     * 

     * @param line

     * @return angle (radians)

     */

    public double getAngle(EuclideanLine2D line);

    /**

     * Returns the angle in radians between this line and the line parameter in the quadrant containing the point parameter

     * 

     * @param line

     * @param quadrant

     * @return angle (radians)

     */

    public double getAngle(EuclideanLine2D line, Point2D quadrant);

    /**

     * Returns the minor angle in degrees between this line and the line parameter

     *

     * @param line

     * @return angle (degrees)

     */

    public double getDegreesAngle(EuclideanLine2D line);

    /**

     * Returns the angle in degrees between this line and the line parameter in the quadrant containing the point parameter

     *

     * @param line

     * @param quadrant

     * @return angle (degrees)

     */

    public double getDegreesAngle(EuclideanLine2D line, Point2D quadrant);

    /**

     * Returns the distance between this line and the point whose coordinates are the parameters

     * 

     * @param pointX

     * @param pointY

     * @return distance line-point

     */

    public double getDistance(double pointX, double pointY);

    /**

     * Returns the distance between this line and the point

     *

     * @param point

     * @return distance line-point

     */

    public double getDistance(Point2D point);

    /**

     * Return the distance between this line and the parameter line

     * 

     * @param line

     * @return distance line-line

     */

    public double getDistance(EuclideanLine2D line);

    /**

     * Returns true if this line and the line passed as parameter are parallel

     * 

     * @param line

     * @return boolean

     */

    public boolean isParallel(EuclideanLine2D line);

    /**

     * Returns the intersection between this line and the line passed as parameter

     * 

     * @param line

     * @return intersection point

     */

    public Point2D getIntersection(EuclideanLine2D line);

    /**

     * Returns a perpendicular line that passes through the point whose coordinates are pointx, pointy

     * 

     * @param pointX

     * @param pointY

     * @return

     */

    public EuclideanLine2D getPerpendicular(double pointX, double pointY);

    /**

     * Returns a perpendicular line that passes through a point

     * 

     * @param point

     * @return perpendicular line

     */

    public EuclideanLine2D getPerpendicular(Point2D point);

    /**

     * Returns a parallel line that passes through the point whose coordinates are pointx, pointy

     * 

     * @param pointX

     * @param pointY

     * @return parallel line

     */

    public EuclideanLine2D getParallel(double pointX, double pointY);

    /**

     * Returns a parallel line that passes through a point

     * 

     * @param point

     * @return parallel line

     */

    public EuclideanLine2D getParallel(Point2D point);

    /**

     * Returns the nearest point of this line to the point whose coordinates are pointx, pointy

     *

     * @param pointX

     * @param pointY

     * @return nearestPoint

     */

    public Point2D getNearestPoint(double pointX, double pointY);

    /**

     * Returns the nearest point of this line to the point

     *

     * @param point

     * @return nearestPoint

     */

    public Point2D getNearestPoint(Point2D point);

    /**

     * Returns the bisectors between this line and the line passed as parameter

     *

     * @param line

     * @return bisectors

     */

    public EuclideanLine2D[] getBisectors(EuclideanLine2D line);

}