Application: gvSIG desktop » gvSIG tools: Vector editing

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2014 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.regularpolygon;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Map;

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.Geometry.SUBTYPES;

import org.gvsig.fmap.geom.Geometry.TYPES;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.geom.aggregate.MultiCurve;

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

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

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

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

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

import org.gvsig.fmap.geom.type.GeometryType;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.service.spi.ProviderServices;

import org.gvsig.vectorediting.lib.api.DrawingStatus;

import org.gvsig.vectorediting.lib.api.EditingServiceParameter;

import org.gvsig.vectorediting.lib.api.exceptions.DrawServiceException;

import org.gvsig.vectorediting.lib.api.exceptions.FinishServiceException;

import org.gvsig.vectorediting.lib.api.exceptions.InvalidEntryException;

import org.gvsig.vectorediting.lib.api.exceptions.StartServiceException;

import org.gvsig.vectorediting.lib.api.exceptions.StopServiceException;

import org.gvsig.vectorediting.lib.spi.AbstractEditingProvider;

import org.gvsig.vectorediting.lib.spi.DefaultDrawingStatus;

import org.gvsig.vectorediting.lib.spi.DefaultEditingServiceParameter;

import org.gvsig.vectorediting.lib.spi.EditingProvider;

import org.gvsig.vectorediting.lib.spi.EditingProviderFactory;

import org.gvsig.vectorediting.lib.spi.EditingProviderLocator;

import org.gvsig.vectorediting.lib.spi.EditingProviderManager;

import org.gvsig.vectorediting.lib.spi.EditingProviderServices;

/**

 *

 * @author llmarques

 *

 */

public class RegularPolygonEditingProvider extends AbstractEditingProvider

    implements EditingProvider {

    protected final Integer DEFAULT_VALUE_SIDES = 5;

    protected final String DEFAULT_VALUE_MODE = "key_inscribed";

    protected final String SIDES_KEY= "sides";

    protected final String MODE_KEY = "mode";

    protected EditingServiceParameter polygonSides;

    protected EditingServiceParameter center;

    protected EditingServiceParameter mode;

    protected EditingServiceParameter pointOfCircle;

    protected Map<EditingServiceParameter, Object> values;

    protected Map<String, String> defaultValues = null;

    protected Map<String, String> options;

    protected FeatureStore featureStore;

    public RegularPolygonEditingProvider(ProviderServices providerServices,

        DynObject parameters) {

        super(providerServices);

        this.featureStore =

            (FeatureStore) parameters

                .getDynValue(EditingProviderFactory.FEATURE_STORE_FIELD);

        Integer sideDefaultValue = Integer.valueOf((String)getDefaultValues().get(SIDES_KEY));

        if (sideDefaultValue == null){

            sideDefaultValue = DEFAULT_VALUE_SIDES;

        }

        polygonSides =

            new DefaultEditingServiceParameter(SIDES_KEY, sideDefaultValue,

                "sides_of_regular_polygon", EditingServiceParameter.TYPE.VALUE);

        I18nManager i18nManager = ToolsLocator.getI18nManager();

        options = new LinkedHashMap<String, String>();

        options.put(i18nManager.getTranslation("key_inscribed"), "inscribed");

        options.put(i18nManager.getTranslation("key_circumscribed"),

            "circumscribed");

        EditingProviderServices editingProviderServices =

            (EditingProviderServices) getProviderServices();

        String consoleMsg =

            editingProviderServices.makeConsoleMessage(null, options);

        String modeDefaultValue = (String)getDefaultValues().get(MODE_KEY);

        if (modeDefaultValue == null){

            modeDefaultValue = DEFAULT_VALUE_MODE;

        }

        mode =

            new DefaultEditingServiceParameter(MODE_KEY, consoleMsg, options,

                modeDefaultValue,

                EditingServiceParameter.TYPE.OPTION);

        center =

            new DefaultEditingServiceParameter("center",

                "center_of_regular_polygon",

                EditingServiceParameter.TYPE.POSITION);

        pointOfCircle =

            new DefaultEditingServiceParameter("point_of_circle",

                "point_of_circle", EditingServiceParameter.TYPE.POSITION);

    }

    private Map<String, String> getDefaultValues() {

        if (this.defaultValues == null){

            EditingProviderManager editingProviderManager =

                EditingProviderLocator.getProviderManager();

            this.defaultValues = editingProviderManager.getDefaultValues("regularpolygon");

        }

        return this.defaultValues;

    }

    public EditingServiceParameter next() {

        if (values.get(polygonSides) == null) {

            return polygonSides;

        } else if (values.get(mode) == null) {

            return mode;

        } else if (values.get(center) == null) {

            return center;

        } else if (values.get(pointOfCircle) == null) {

            return pointOfCircle;

        }

        return null;

    }

    public DrawingStatus getDrawingStatus(Point mousePosition)

        throws DrawServiceException {

        DefaultDrawingStatus drawingStatus = new DefaultDrawingStatus();

        EditingProviderManager editingProviderManager =

            EditingProviderLocator.getProviderManager();

        ISymbol lineSymbolEditing = editingProviderManager.getSymbol("line-symbol-editing");

        ISymbol auxiliaryLineSymbolEditing = editingProviderManager.getSymbol("auxiliary-line-symbol-editing");

        ISymbol auxiliaryPointSymbolEditing = editingProviderManager.getSymbol("auxiliary-point-symbol-editing");

        GeometryManager geometryManager = GeometryLocator.getGeometryManager();

        if (values != null) {

            Integer sidesValue = (Integer) values.get(polygonSides);

            String modeValue = (String) values.get(mode);

            Point centerValue = (Point) values.get(center);

            if (centerValue != null) {

                try {

                    EditingProviderServices editingProviderServices =

                        (EditingProviderServices) getProviderServices();

                    int subtype =

                        editingProviderServices.getSubType(featureStore);

                    if (modeValue == null) {

                        modeValue = (String)getDefaultValues().get(MODE_KEY);

                    }

                    Curve polygon =

                        calculateRegularPolygon(modeValue, centerValue,

                            mousePosition, sidesValue);

                    Curve line =

                        editingProviderServices.createLine(centerValue,

                            mousePosition, subtype);

                    double radius = mousePosition.distance(centerValue);

                    Circumference circumference = (Circumference) geometryManager.create(TYPES.CIRCUMFERENCE, SUBTYPES.GEOM2D);

                    circumference.setPoints(centerValue, radius);

                    drawingStatus.addStatus(circumference, auxiliaryLineSymbolEditing, "");

                    if(polygon!=null){

                        drawingStatus.addStatus(polygon, lineSymbolEditing, "");

                    }

                    drawingStatus.addStatus(centerValue, auxiliaryPointSymbolEditing, "");

                    drawingStatus.addStatus(line, auxiliaryLineSymbolEditing, "");

                } catch (BaseException e) {

                    throw new DrawServiceException(e);

                }

            }

        }

        return drawingStatus;

    }

    /**

     * Calculates polygon as of mode (inscribed or circumscribed), center of

     * polygon, point of circle and number of sides.

     *

     * @param modeValue

     *            of polygon (inscribed or circumscribed).

     * @param centerValue

     *            of polygon

     * @param pointOfCircleValue

     *            of circle that inscribe or circumscribe polygon

     * @param sidesValue

     *            number of sides.

     */

    protected Curve calculateRegularPolygon(String modeValue,

        Point centerValue, Point pointOfCircle, int sidesValue)

        throws BaseException {

        GeometryManager geometryManager = GeometryLocator.getGeometryManager();

        EditingProviderServices editingProviderServices =

            (EditingProviderServices) getProviderServices();

        int subtype = editingProviderServices.getSubType(featureStore);

        Curve polygon =

            (Curve) geometryManager.create(Geometry.TYPES.CURVE, subtype);

        double initAngle =

            editingProviderServices.getAngle(centerValue, pointOfCircle);

        double radiusValue = pointOfCircle.distance(centerValue);

        if(radiusValue == 0.0){

            return null;

        }

        double theta = -(2 * Math.PI) / sidesValue;

        if (modeValue.equalsIgnoreCase("key_inscribed")) {

            for (int i = 0; i < sidesValue; ++i) {

                double x =

                    centerValue.getX()

                        + (radiusValue * Math.cos((theta * i) + initAngle));

                double y =

                    centerValue.getY()

                        + (radiusValue * Math.sin((theta * i) + initAngle));

                Point createPoint =

                    editingProviderServices.createPoint(x, y, subtype);

                polygon.addVertex(createPoint);

            }

        } else if (modeValue.equalsIgnoreCase("key_circumscribed")) {

            for (int i = 0; i < sidesValue; ++i) {

                double x =

                    centerValue.getX()

                        + (radiusValue * Math.cos((theta * i) + initAngle));

                double y =

                    centerValue.getY()

                        + (radiusValue * Math.sin((theta * i) + initAngle));

                Point apothemPoint =

                    editingProviderServices.createPoint(x, y, subtype);

                Double[] apothemParams =

                    editingProviderServices.getLineParams(centerValue,

                        apothemPoint);

                Point[] perpendicular =

                    editingProviderServices.getPerpendicular(apothemParams[0],

                        apothemParams[1], apothemPoint, subtype);

                double x1 =

                    centerValue.getX()

                        + (radiusValue * Math

                            .cos((theta * (i + 1)) + initAngle));

                double y1 =

                    centerValue.getY()

                        + (radiusValue * Math

                            .sin((theta * (i + 1)) + initAngle));

                Point nextApothemPoint =

                    editingProviderServices.createPoint(x1, y1, subtype);

                Double[] nextApothemParams =

                    editingProviderServices.getLineParams(centerValue,

                        nextApothemPoint);

                Point[] nextPerpendicular =

                    editingProviderServices.getPerpendicular(

                        nextApothemParams[0], nextApothemParams[1],

                        nextApothemPoint, subtype);

                Point vertex =

                    editingProviderServices.getIntersection(perpendicular,

                        nextPerpendicular, subtype);

                polygon.addVertex(vertex);

            }

        }

        polygon = (Curve) closeGeometry(polygon);

        return polygon;

    }

    /**

     * Close geometry if it is necessary.

     *

     * @param geometry

     *            to be closed.

     */

    protected Geometry closeGeometry(Geometry geometry) {

        if (!isClose(geometry) && (geometry != null)) {

            if (geometry instanceof Surface) {

                Surface surface = (Surface) geometry;

                Point firstp = surface.getVertex(0);

                firstp = (Point) firstp.cloneGeometry();

                surface.addVertex(firstp);

                return surface;

            } else if (geometry instanceof Curve) {

                Curve line = (Curve) geometry;

                Point firstp = line.getVertex(0);

                firstp = (Point) firstp.cloneGeometry();

                line.addVertex(firstp);

                return line;

            }

        }

        return geometry;

    }

    /**

     * Gets if the geometry received by parameter is closed or not.

     *

     * @param geometry

     * @return True if geometry is closed, otherwise false.

     */

    private boolean isClose(Geometry geometry) {

        if (geometry != null) {

            if (geometry instanceof OrientablePrimitive) {

                OrientablePrimitive orientablePrimitive =

                    (OrientablePrimitive) geometry;

                Point firstPoint = orientablePrimitive.getVertex(0);

                Point lastPoint =

                    orientablePrimitive.getVertex(orientablePrimitive

                        .getNumVertices() - 1);

                if (firstPoint.equals(lastPoint)) {

                    return true;

                }

            }

        }

        return false;

    }

    public void stop() throws StopServiceException {

        if (values != null) {

            values.clear();

        }

    }

    public List<EditingServiceParameter> getParameters() {

        List<EditingServiceParameter> parameters =

            new ArrayList<EditingServiceParameter>();

        parameters.add(polygonSides);

        parameters.add(mode);

        parameters.add(center);

        parameters.add(pointOfCircle);

        return parameters;

    }

    public void setValue(Object value) throws InvalidEntryException {

        EditingServiceParameter parameter = next();

        validateAndInsertValue(parameter, value);

    }

    private void validateAndInsertValue(EditingServiceParameter param,

        Object value) throws InvalidEntryException {

        if (param == polygonSides) {

            if (value instanceof Double) {

                Integer sides = ((Double) value).intValue();

                if (sides > 2) {

                    values.put(param, sides);

                    getDefaultValues().put(SIDES_KEY, sides.toString());

                    polygonSides.setDefaultValue(sides.toString());

                    return;

                } else {

                    throw new InvalidEntryException(null);

                }

            } else if (value instanceof Point) {

                values.put(param, Integer.valueOf((String)getDefaultValues().get(SIDES_KEY)));

                values.put(center, (Point) value);

                return;

            }

        } else if (param == mode) {

            if (value instanceof String) {

                I18nManager i18nManager = ToolsLocator.getI18nManager();

                String option = (String) value;

                if (option.equalsIgnoreCase(i18nManager

                    .getTranslation("key_inscribed"))) {

                    values.put(param, "key_inscribed");

                    getDefaultValues().put(MODE_KEY, "key_inscribed");

                    mode.setDefaultValue("key_inscribed");

                    return;

                } else if (option.equalsIgnoreCase(i18nManager

                    .getTranslation("key_circumscribed"))) {

                    values.put(param, "key_circumscribed");

                    getDefaultValues().put(MODE_KEY, "key_circumscribed");

                    mode.setDefaultValue("key_circumscribed");

                    return;

                } else {

                    throw new InvalidEntryException(null);

                }

            } else if (value instanceof Point) {

                values.put(param, getDefaultValues().get(MODE_KEY));

                if(values.get(center) != null){

                    values.put(pointOfCircle, (Point) value);

                } else {

                    values.put(center, (Point) value);

                }

                return;

            }

        } else if (param == center) {

            if (value instanceof Point) {

                values.put(param, value);

                return;

            }

        } else if (param == pointOfCircle) {

            if (value instanceof Point) {

                values.put(param, value);

                return;

            }

        }

        throw new InvalidEntryException(null);

    }

    public Geometry finish() throws FinishServiceException {

        if (values != null) {

            Integer sidesValue = (Integer) values.get(polygonSides);

            String modeValue = (String) values.get(mode);

            Point centerValue = (Point) values.get(center);

            Point pointOfCircleValue = (Point) values.get(pointOfCircle);

            try {

                Curve polygon =

                    calculateRegularPolygon(modeValue, centerValue,

                        pointOfCircleValue, sidesValue);

                if(polygon!=null){

                    EditingProviderServices editingProviderServices =

                        (EditingProviderServices) getProviderServices();

                    GeometryType geomType =

                        editingProviderServices.getGeomType(featureStore);

                    if (geomType.isTypeOf(Geometry.TYPES.MULTICURVE)) {

                        MultiCurve multiCurve =

                            GeometryLocator.getGeometryManager().createMultiCurve(

                                geomType.getSubType());

                        multiCurve.addCurve(polygon);

                        return multiCurve;

                    }

                }

                return polygon;

            } catch (Exception e) {

                throw new FinishServiceException(e);

            }

        }

        return null;

    }

    public void finishAndStore() throws FinishServiceException {

        try {

            Geometry geometry = finish();

            if (geometry != null) {

                EditingProviderServices editingProviderServices =

                    (EditingProviderServices) getProviderServices();

                editingProviderServices.insertGeometryIntoFeatureStore(

                    geometry, featureStore);

            }

        } catch (Exception e) {

            throw new FinishServiceException(e);

        }

    }

    public void start() throws StartServiceException {

        values = new HashMap<EditingServiceParameter, Object>();

    }

    public String getName() {

        return RegularPolygonEditingProviderFactory.PROVIDER_NAME;

    }

}