Application: gvSIG desktop » gvSIG tools: Vector editing

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2015 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.vectorediting.lib.prov.extendline.operation;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.FeatureSelection;

import org.gvsig.fmap.geom.exception.CreateGeometryException;

import org.gvsig.fmap.geom.operation.GeometryOperationException;

import org.gvsig.fmap.geom.operation.GeometryOperationNotSupportedException;

import org.gvsig.fmap.geom.primitive.Curve;

import org.gvsig.fmap.geom.primitive.Point;

/**

 * Represents an operation to extend curve.

 * 

 * @author llmarques

 *

 */

public interface ExtendLineOperation {

    /**

     * Extend line to boundary objects received as parameters.

     * 

     * Inserted point is the point inserted by user. It is used to determinate

     * what side of curve it must extend.

     * 

     * If curveToBeExtended does not intersect with any geometry, the geometry will

     * not be modified.

     * 

     * @param curveToBeExtended

     *            Curve to be extended.

     * @param insertedPoint

     *            Point inserted by user to determinate what side of curve must

     *            be extended.

     * @param boundaryObjects

     *            If curveToBeExtended intersects with some boundary object, it will

     *            be extend to it. If there are several boundary objects that

     *            intersects with curveToBeExtended, it will be extended to nearest

     *            point.

     * @return extended line.

     */

    public Curve extendLine(Curve curveToBeExtended, Point insertedPoint,

        FeatureSelection boundaryObjects)

        throws GeometryOperationNotSupportedException,

        GeometryOperationException, DataException, CreateGeometryException;

}