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.marker.impl;

import java.awt.Color;

import java.awt.Graphics2D;

import java.awt.Rectangle;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.io.IOException;

import java.net.URL;

import org.gvsig.compat.print.PrintAttributes;

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

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.geom.primitive.Point;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.MapContextLocator;

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.fmap.mapcontext.rendering.symbol.marker.IPictureMarkerSymbol;

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

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;

/**

 * PictureMarkerSymbol allows to use an image file as a definition to be painted

 * instead of a marker symbol.

 */

@SuppressWarnings("UseSpecificCatch")

public class PictureMarkerSymbol extends AbstractMarkerSymbol implements IPictureMarkerSymbol {

    private final Logger LOG = LoggerFactory.getLogger(PictureMarkerSymbol.class);

    public static final String PICTURE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

            = "PictureMarkerSymbol";

    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 float SELECTION_OPACITY_FACTOR = .3F;

    private boolean selected;

    private PictureMarkerSymbol selectionSym;

    private BackgroundFileStyle bgImage;

    private BackgroundFileStyle bgSelImage;

    public PictureMarkerSymbol() {

        super();

        setSize(18);

    }

    /**

     * 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 PictureMarkerSymbol(URL imageURL, URL selImageURL) throws IOException {

        setImage(imageURL);

        if (selImageURL != null) {

            setSelImage(selImageURL);

        } else {

            setSelImage(imageURL);

        }

    }

    /**

     * Sets the file for the image to be used as a marker symbol

     *

     * @param imageUrl

     * @throws IOException

     */

    @Override

    public void setImage(URL imageUrl) throws IOException {

        bgImage = BackgroundFileStyle.createStyleByURL(imageUrl);

        bgImage.setSymbolTable(this.getSymbolTable(this.getFeature()));

    }

    /**

     * Sets the file for the image to be used as a marker symbol (when it is

     * selected in the map)

     *

     * @param imageFileUrl

     * @throws IOException

     */

    @Override

    public void setSelImage(URL imageFileUrl) throws IOException {

        bgSelImage = BackgroundFileStyle.createStyleByURL(imageFileUrl);

        bgSelImage.setSymbolTable(this.getSymbolTable(this.getFeature()));

    }

    @Override

    public ISymbol getSymbolForSelection() {

        if (selectionSym == null) {

            try {

                selectionSym = (PictureMarkerSymbol) this.clone();

            } catch (CloneNotSupportedException e) {

                LOG.warn("Error creating the selection symbol for the symbol "+ this, e);

            }

            selectionSym.selected = true;

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

        } else {

            selectionSym.setColor(MapContext.getSelectionColor());

        }

        return selectionSym;

    }

    @Override

    public void draw(Graphics2D g,

            AffineTransform affineTransform,

            Geometry geom,

            Feature f,

            Cancellable cancel) {

        Point p;

        try {

            p = geom.centroid();

        } catch (Exception ex) {

            return;

        }

        if (affineTransform != null) {

            p.transform(affineTransform);

        }

        double x, y;

        int size = (int) Math.round(getEfectiveSize(f));

        double halfSize = getEfectiveSize(f) / 2;

        x = p.getX() - halfSize;

        y = p.getY() - halfSize;

        Point2D theOffset = this.getEfectiveOffset(f);

        int xOffset = (int) theOffset.getX();

        int yOffset = (int) theOffset.getY();

        if (size > 0) {

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

            Rectangle rect = new Rectangle(size, size);

            g.translate(x + xOffset, y + yOffset);

            double auxRotation = getEfectiveRotationInRadians(f);

            g.rotate(auxRotation, halfSize, halfSize);

            if (bg != null) {

                try {

                    bg.setSymbolTable(this.getSymbolTable(f));

                    bg.drawInsideRectangle(g, rect);

                } catch (SymbolDrawingException e) {

                    LOG.warn(Messages.getText("label_style_could_not_be_painted")

                            + ": " + bg.getSource().toString(),

                            e);

                }

            } else {

                LOG.warn(Messages.getText("label_style_could_not_be_painted")

                        + ": bg is Null");

            }

            g.rotate(-auxRotation, halfSize, halfSize);

            g.translate(-(x + xOffset), -(y + yOffset));

            if( isDrawLineToOffset() ) {

                g.setColor(this.getEfectiveLineToOffsetColor(f));

                g.drawLine((int)p.getX(), (int)p.getY(), (int)p.getX() + xOffset, (int)p.getY() + yOffset);

            }

        }

    }

    @Override

    public void drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) throws SymbolDrawingException {

        /*

         * Marker symbols which are not simple (images, etc)

         * are resized when drawn inside a rectangle

         */

        double saved_size = this.getSize();

        this.setSize(r.getHeight());

        super.drawInsideRectangle(g, scaleInstance, r, properties);

        this.setSize(saved_size);

    }

    public String getClassName() {

        return getClass().getName();

    }

    /**

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

     *

     * @return imagePath,URL

     */

    @Override

    public URL getSource() {

        return bgImage.getSource();

    }

    /**

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

     * selected in the map)

     *

     * @return selimagePath,URL

     */

    @Override

    public URL getSelectedSource() {

        return bgSelImage.getSource();

    }

    @Override

    public PictureMarkerSymbol clone() throws CloneNotSupportedException {

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

        // clone selection

        if (selectionSym != null) {

            //to avoid an infinite loop

            if (this == selectionSym) {

                copy.selectionSym = copy;

            } else {

                copy.selectionSym = (PictureMarkerSymbol) 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();

        }

        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 = (PictureMarkerSymbol) state.get(SELECTION_SYMBOL);

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

        this.bgSelImage = (BackgroundFileStyle) state.get(BACKGROUND_SELECTION_IMAGE);

    }

    @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);

    }

    public static class RegisterPersistence implements Callable {

        @Override

        public Object call() throws Exception {

            PersistenceManager manager = ToolsLocator.getPersistenceManager();

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

                DynStruct definition

                        = manager.addDefinition(PictureMarkerSymbol.class,

                                PICTURE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME,

                                PICTURE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

                                + " Persistence definition",

                                null,

                                null);

                // Extend the Style base definition

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

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

                definition.addDynFieldObject(SELECTION_SYMBOL).setMandatory(false)

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

                definition.addDynFieldObject(BACKGROUND_IMAGE)

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

                definition.addDynFieldObject(BACKGROUND_SELECTION_IMAGE)

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

            }

            return true;

        }

    }

    public static class RegisterSymbol implements Callable {

        @Override

        public Object call() throws Exception {

            SymbolManager manager = MapContextLocator.getSymbolManager();

            manager.registerSymbol(PictureMarkerSymbol.PICTURE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME,

                    PictureMarkerSymbol.class);

            return true;

        }

    }

    @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;

    }

    @Override

    public void setFeature(Feature feature) {

        super.setFeature(feature);

        if( this.bgImage!=null ) {

            this.bgImage.setSymbolTable(this.getSymbolTable(this.getFeature()));

        }

        if( this.bgSelImage!=null ) {

            this.bgSelImage.setSymbolTable(this.getSymbolTable(this.getFeature()));

        }

    }

}