Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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 3

 * 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.symbology.fmap.mapcontext.rendering.symbol.line.impl;

import java.awt.BasicStroke;

import java.awt.Color;

import java.awt.Dimension;

import java.awt.Graphics2D;

import java.awt.Point;

import java.awt.Rectangle;

import java.awt.Shape;

import java.awt.geom.AffineTransform;

import java.awt.geom.PathIterator;

import java.awt.geom.Point2D;

import java.io.IOException;

import java.net.URL;

import org.apache.batik.ext.awt.geom.DefaultPathLength;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.compat.print.PrintAttributes;

import org.gvsig.expressionevaluator.ExpressionUtils;

import org.gvsig.expressionevaluator.SymbolTable;

import org.gvsig.fmap.dal.DALLocator;

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

import org.gvsig.fmap.dal.expressionevaluator.FeatureSymbolTable;

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

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

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

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.mapcontext.MapContextLocator;

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

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

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

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

import org.gvsig.i18n.Messages;

import org.gvsig.symbology.PathLength;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.IPictureLineSymbol;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.BackgroundFileStyle;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.IMask;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.task.Cancellable;

import org.gvsig.tools.util.Callable;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * PictureLineSymbol allows to use any symbol defined as an image (by an image file)

 * supported  by gvSIG.This symbol will be used as an initial object.The line will be

 * painted as a succession of puntual symbols through the path defined by it(the line).

 */

public class PictureLineSymbol extends AbstractLineSymbol implements IPictureLineSymbol  {

        private static final Logger logger = LoggerFactory.getLogger(PictureLineSymbol.class);

    public static final String PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME =

        "PictureLineSymbol";

    private static final String SELECTED = "selected";

    private static final String SELECTION_SYMBOL = "selectionSym";

    private static final String BACKGROUND_IMAGE = "bgImage";

    private static final String BACKGROUND_SELECTION_IMAGE = "bgSelImage";

    private static final String WIDTH = "width";

    private static final String FIELD_SIZE_EXPRESSION = "sizeExpression";

        transient private PictureLineSymbol selectionSym;

        private double width;

        private boolean selected;

        private BackgroundFileStyle bgImage;

        private BackgroundFileStyle bgSelImage;

        private PrintAttributes properties;

        private double rotation;

        private Point2D offset = new Point2D.Double();

        private IMask mask;

        private Color lineToOffsetColor;

        private boolean drawLineToOffset;

        private String sizeExpression;

        private String offsetXExpression;

        private String offsetYExpression;

        private String rotationExpression;

        private String lineToOffsetColorExpression;

        /**

         * Constructor method

         *

         */

        public PictureLineSymbol() {

                super();

        }

        /**

         * Constructor method

         * @param imageURL, URL of the normal image

         * @param selImageURL, URL of the image when it is selected in the map

         * @throws IOException

         */

        public PictureLineSymbol(URL imageURL, URL selImageURL) throws IOException {

            setImage(imageURL);

            if (selImageURL != null) {

                setSelImage(selImageURL);

            } else {

                setSelImage(imageURL);

            }

        }

        /**

         * Sets the URL for the image to be used as a picture line symbol

         * @param imageFile, File

         * @throws IOException

         */

        @Override

        public void setImage(URL imageUrl) throws IOException{

                bgImage= BackgroundFileStyle.createStyleByURL(imageUrl);

        }

        /**

         * Sets the URL for the image to be used as a picture line symbol (when it is selected in the map)

         * @param imageFile, File

         * @throws IOException

         */

        @Override

        public void setSelImage(URL selImageUrl) throws IOException{

            bgSelImage= BackgroundFileStyle.createStyleByURL(selImageUrl);

        }

        @Override

        public void setLineWidth(double width) {

                this.width = width;

                getLineStyle().setLineWidth((float) width);

        }

        @Override

        public double getLineWidth() {

                return width;

        }

        @Override

        public ISymbol getSymbolForSelection(Color selectionColor) {

                if (selectionSym == null) {

                        selectionSym = (PictureLineSymbol) cloneForSelection(selectionColor);

                        selectionSym.selected=true;

                        selectionSym.selectionSym = selectionSym; // avoid too much lazy creations

                }else{

                    selectionSym.setColor(selectionColor);

                }

                if (selectionSym instanceof CartographicSupport) {

                    ((CartographicSupport) selectionSym).setUnit(this.getUnit());

                }

                return selectionSym;

        }

    @Override

    public void draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel, Rectangle r) {

        if(r != null){

            geom = getSampleGeometry(r);

        }

        double effectiveSize = getEfectiveSize(f);

        double scale = getScale(effectiveSize);

        if (scale <= 0 ) {

            return;

        }

        Shape geom_transf_clip = geom.getShape(affineTransform);

        BackgroundFileStyle bg = (!selected) ? bgImage : bgSelImage;

        Rectangle bounds = bg.getBounds();

        final double imageHeight = effectiveSize; //getCartographicSize(); //toCartographicUnits(getSize());

        final double imageWidth = bounds.getWidth() * scale;

        if (imageWidth <= 0 || imageHeight <= 0) {

            return;

        }

        int height = (int) imageHeight; //csWidth;

        float csWidth = height; //(float) toCartographicUnits(getLineStyle().getLineWidth());

        BasicStroke bs = new BasicStroke(

                (float) csWidth,

                BasicStroke.CAP_ROUND,

                BasicStroke.CAP_ROUND);

        g.setClip(bs.createStrokedShape(geom_transf_clip));

        PathLength pl = new DefaultPathLength(geom_transf_clip);

        PathIterator iterator = geom_transf_clip.getPathIterator(null, 0.8);

        double[] theData = new double[6];

        Point2D firstPoint = null, startPoint = null, endPoint = null;

        if (!iterator.isDone()) {

            if (iterator.currentSegment(theData) != PathIterator.SEG_CLOSE) {

                firstPoint = new Point2D.Double(theData[0], theData[1]);

            }

        }

        float currentPathLength = 1;

        Rectangle rect = new Rectangle();

        while ((cancel == null || !cancel.isCanceled()) && !iterator.isDone()) {

            int theType = iterator.currentSegment(theData);

            switch (theType) {

                case PathIterator.SEG_MOVETO:

                    startPoint = new Point2D.Double(theData[0], theData[1]);

                    endPoint = null;

                    iterator.next();

                    continue;

                case PathIterator.SEG_LINETO:

                case PathIterator.SEG_QUADTO:

                case PathIterator.SEG_CUBICTO:

                    endPoint = new Point2D.Double(theData[0], theData[1]);

                    break;

                case PathIterator.SEG_CLOSE:

                    endPoint = startPoint;

                    startPoint = firstPoint;

                    break;

            }

            double a = endPoint.getX() - startPoint.getX();

            double b = endPoint.getY() - startPoint.getY();

            double theta = pl.angleAtLength(currentPathLength);

            if(this.getEfectiveRotationInRadians(f) != 0.0){

                theta += this.getEfectiveRotationInRadians(f);

            }

            double x = startPoint.getX();

            double y = startPoint.getY();

            // Theorem of Pythagoras

            float segmentLength = (float) Math.sqrt(a * a + b * b);

            // compute how many times the image has to be drawn

            // to completely cover this segment's length

            int count = (int) Math.ceil(segmentLength / imageWidth);

            for (int i = 0; (cancel == null || !cancel.isCanceled()) && i < count; i++) {

                g.translate(x, y);

                g.rotate(theta);

                double xOffsetTranslation = imageWidth * i;

                g.translate(xOffsetTranslation, -csWidth);

                rect.setBounds(0, (int) Math.round(height * .5), (int) Math.ceil(imageWidth), height);

                Dimension rectSize = rect.getSize();

                if(rectSize.getHeight() > 0 && rectSize.getWidth() > 0) {

                    try {

                        bg.drawInsideRectangle(g, rect, false);

                    } catch (SymbolDrawingException e) {

                        logger.warn(Messages.getText("label_style_could_not_be_painted"), e);

                    }

                }

                g.translate(-xOffsetTranslation, csWidth);

                g.rotate(-theta);

                g.translate(-x, -y);

            }

            startPoint = endPoint;

            currentPathLength += segmentLength;

            iterator.next();

        }

        g.setClip(null);

    }

    protected double getAdjustedSize(Rectangle r, double size) {

        if (r == null) {

            return size;

        }

        double min = Math.min(r.getHeight(), r.getWidth());

        if (size > min) {

            size = min;

        }

        return size;

    }

        public String getClassName() {

                return getClass().getName();

        }

        /**

         * Returns the URL of the image that is used as a picture line symbol (when it

         * is selected in the map)

         * @return selimagePath,URL

         */

        @Override

        public URL getSelectedSource(){

                return bgSelImage.getSource();

        }

        /**

         * Returns the URL of the image that is used as a picture line symbol

         * @return imagePath,URL

         */

        @Override

        public URL getSource() {

                return bgImage.getSource();

        }

        /**

         * Returns the yscale for the picture line symbol

         * @param yScale

         */

        private double getScale(double size) {

            BackgroundFileStyle image;

            if(selected){

                image = bgSelImage;

            } else {

                image = bgImage;

            }

            return size/image.getBounds().getHeight();

        }

        @Override

    public Object clone() throws CloneNotSupportedException {

        PictureLineSymbol copy = (PictureLineSymbol) super.clone();

        // clone selection

        if (selectionSym != null) {

                //to avoid an infinite loop

                if (this == selectionSym){

                        copy.selectionSym = copy;

                } else {

                        copy.selectionSym = (PictureLineSymbol) selectionSym.clone();

                }

        }

        // clone brackground image

        if (bgImage != null) {

            copy.bgImage = (BackgroundFileStyle) bgImage.clone();

        }

        // clone selection brackground image

        if (bgSelImage != null) {

            copy.bgSelImage = (BackgroundFileStyle) bgSelImage.clone();

        }

        // FIXME: clone properties

        return copy;

    }

        @Override

    public void loadFromState(PersistentState state) throws PersistenceException {

        // Set parent style properties

        super.loadFromState(state);

        this.selected = (Boolean) state.get(SELECTED);

        this.selectionSym = (PictureLineSymbol) state.get(SELECTION_SYMBOL);

        this.bgImage = (BackgroundFileStyle) state.get(BACKGROUND_IMAGE);

        this.bgSelImage =

            (BackgroundFileStyle) state.get(BACKGROUND_SELECTION_IMAGE);

        this.setLineWidth(state.getDouble(WIDTH));

        this.setLineWidth(state.getDouble(WIDTH));

        this.setSizeExpression(state.getString(FIELD_SIZE_EXPRESSION));

    }

        @Override

    public void saveToState(PersistentState state) throws PersistenceException {

        // Save parent fill symbol properties

        super.saveToState(state);

        // Save own properties

        state.set(SELECTED, this.selected);

        state.set(SELECTION_SYMBOL, this.getSymbolForSelection());

        state.set(BACKGROUND_IMAGE, this.bgImage);

        state.set(BACKGROUND_SELECTION_IMAGE, this.bgSelImage);

        state.set(WIDTH, width);

        state.set(FIELD_SIZE_EXPRESSION, this.getSizeExpression());

    }

    private FeatureSymbolTable symbolTable = null;

    protected SymbolTable getSymbolTable(Feature f) {

        if (symbolTable == null) {

            this.symbolTable = DALLocator.getManager().createFeatureSymbolTable();

            this.symbolTable.addSymbolTable(ExpressionUtils.createSymbolTable());

        }

        symbolTable.setFeature(f);

        return symbolTable;

    }

    @Override

    public Color getEfectiveLineToOffsetColor(Feature f) {

        if (f == null) {

            f = this.getFeature();

        }

        if (f == null || StringUtils.isBlank(this.lineToOffsetColorExpression)) {

            return this.getLineToOffsetColor();

        }

        Color theColor = ExpressionUtils.parseColor(

                this.getSymbolTable(f),

                this.lineToOffsetColorExpression,

                this.getLineToOffsetColor()

        );

        return theColor;

    }

    @Override

    public Point2D getEfectiveOffset(Feature f) {

        if (f == null) {

            f = this.getFeature();

        }

        Point2D p;

        if (f == null || StringUtils.isBlank(this.offsetXExpression) || StringUtils.isBlank(this.offsetYExpression)) {

            p = this.getOffset();

            p = new Point2D.Double(

                    toCartographicUnits(p.getX()),

                    toCartographicUnits(p.getY())

            );

        } else {

            double offsetX = toCartographicUnits(ExpressionUtils.parseDouble(

                    this.getSymbolTable(f),

                    offsetXExpression,

                    (int) this.getOffset().getX()

            ));

            double offsetY = toCartographicUnits(ExpressionUtils.parseDouble(

                    this.getSymbolTable(f),

                    offsetYExpression,

                    (int) this.getOffset().getY()

            ));

            p = new Point2D.Double(offsetX, offsetY);

        }

        return p;

    }

    @Override

    public double getEfectiveRotationInDegres(Feature f) {

        if (StringUtils.isBlank(this.rotationExpression)) {

            return Math.toDegrees(this.getRotation());

        }

        // Por defecto vedra en grados.

        if (f == null) {

            f = this.getFeature();

        }

        if (f == null) {

            return Math.toDegrees(this.getRotation());

        }

        double r = ExpressionUtils.parseDouble(

                this.getSymbolTable(f),

                rotationExpression,

                this.getRotation()

        );

        return r;

    }

    @Override

    public double getEfectiveRotationInRadians(Feature f) {

        // Pillamos el valor por defecto que es en grados y lo transformamos a radianes.

        if (StringUtils.isBlank(this.rotationExpression)) {

            return this.getRotation();

        }

        double r = this.getEfectiveRotationInDegres(f);

        if (r == 0) {

            return 0;

        }

        r = Math.toRadians(r);

        return r;

    }

    private double getCartographicSize() {

        return toCartographicUnits(getSize());

    }

    @Override

    public double getEfectiveSize(Feature f) {

        if (StringUtils.isBlank(this.sizeExpression)) {

            return this.getCartographicSize();

        }

        if (f == null) {

            f = this.getFeature();

        }

        if (f == null) {

            return this.getCartographicSize();

        }

        double sz = ExpressionUtils.parseDouble(

                this.getSymbolTable(f),

                this.sizeExpression,

                -1

        );

        if (sz < 0) {

            return this.getCartographicSize();

        }

        return toCartographicUnits(sz);

    }

    @Override

    public Color getLineToOffsetColor() {

        return this.lineToOffsetColor;

    }

    @Override

    public String getLineToOffsetColorExpression() {

        return this.lineToOffsetColorExpression;

    }

    @Override

    public String getOffsetXExpression() {

        return offsetXExpression;

    }

    @Override

    public String getOffsetYExpression() {

        return offsetYExpression;

    }

    @Override

    public String getRotationExpression() {

        return rotationExpression;

    }

    @Override

    public String getSizeExpression() {

        return sizeExpression;

    }

    @Override

    public boolean isDrawLineToOffset() {

        return this.drawLineToOffset;

    }

    @Override

    public void setDrawLineToOffset(boolean drawLineToOffset) {

        this.drawLineToOffset = drawLineToOffset;

    }

    @Override

    public void setLineToOffsetColor(Color color) {

        this.lineToOffsetColor = color;

    }

    @Override

    public void setLineToOffsetColorExpression(String lineToOffsetColorExpression) {

        this.lineToOffsetColorExpression = StringUtils.trimToNull(lineToOffsetColorExpression);

    }

    @Override

    public void setOffsetXExpression(String offsetXExpression) {

        this.offsetXExpression = StringUtils.trimToNull(offsetXExpression);

    }

    @Override

    public void setOffsetYExpression(String offsetYExpression) {

        this.offsetYExpression = StringUtils.trimToNull(offsetYExpression);

    }

    @Override

    public void setRotationExpression(String rotationExpression) {

        this.rotationExpression = StringUtils.trimToNull(rotationExpression);

    }

    @Override

    public void setSizeExpression(String sizeExpression) {

        this.sizeExpression = StringUtils.trimToNull(sizeExpression);

    }

    @Override

    public double getRotation() {

        return rotation;

    }

    @Override

    public void setRotation(double r) {

        this.rotation = r;

        this.setRotationExpression(null);

    }

    @Override

    public Point2D getOffset() {

        if (offset == null) {

            offset = new Point();

        }

        return offset;

    }

    @Override

    public void setOffset(Point2D offset) {

        this.offset = offset;

    }

    @Override

    public double getSize() {

        return getLineWidth();

    }

    @Override

    public void setSize(double size) {

        this.setSizeExpression(null);

        this.setLineWidth(size);

    }

    @Override

    public IMask getMask() {

        return mask;

    }

    @Override

    public void setMask(IMask mask) {

        this.mask = mask;

    }

    @Override

    public String[] getRequiredFeatureAttributeNames(FeatureStore featureStore) throws DataException {

        // By default only need the default Geometry

        FeatureType ftype = featureStore.getDefaultFeatureTypeQuietly();

        String[] res = new String[ftype.size()];

        int cont = 0;

        for (FeatureAttributeDescriptor attr : ftype) {

            res[cont++]=attr.getName();

        }

        return res;

    }

    public static class RegisterPersistence implements Callable {

        @Override

        public Object call() throws Exception {

            PersistenceManager manager = ToolsLocator.getPersistenceManager();

            if (manager.getDefinition(PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME) == null) {

                DynStruct definition =

                    manager.addDefinition(PictureLineSymbol.class,

                                    PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME,

                                    PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

                            + " Persistence definition",

                        null,

                        null);

                // Extend the Style base definition

                definition.extend(manager.getDefinition(LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME));

                definition.addDynFieldBoolean(SELECTED).setMandatory(false);

                definition.addDynFieldObject(SELECTION_SYMBOL)

                    .setClassOfValue(PictureLineSymbol.class).setMandatory(false);

                definition.addDynFieldObject(BACKGROUND_IMAGE)

                    .setClassOfValue(BackgroundFileStyle.class).setMandatory(false);

                definition.addDynFieldObject(BACKGROUND_SELECTION_IMAGE)

                    .setClassOfValue(BackgroundFileStyle.class).setMandatory(false);

                definition.addDynFieldObject(WIDTH)

                    .setClassOfValue(Double.class).setMandatory(true);

                definition.addDynFieldString(FIELD_SIZE_EXPRESSION)

                    .setMandatory(false);

            }

            return Boolean.TRUE;

        }

    }

        public static class RegisterSymbol implements Callable {

                @Override

                public Object call() throws Exception {

                        SymbolManager manager = MapContextLocator.getSymbolManager();

                        manager.registerSymbol(PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME,

                            PictureLineSymbol.class);

                        return Boolean.TRUE;

                }

        }

//    @Override

//    public void getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi) {

//        super.getPixExtentPlus(geom, distances, viewPort, dpi);

//            double pixWidth = toCartographicUnits(width);

//            distances[0] += pixWidth/2;

//            distances[1] += pixWidth/2;

//    }

}