/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008 - 2009, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.display2d.ext.northarrow;

import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Insets;
import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.Shape;
import org.geotoolkit.display.PortrayalException;
import org.geotoolkit.display2d.ext.BackgroundTemplate;
import org.geotoolkit.display2d.ext.BackgroundUtilities;


/**
 * Utility class to render north arrow using a provided template.
 *
 * @author Johann Sorel (Geomatys)
 * @module
 */
public class J2DNorthArrowUtilities {

    private J2DNorthArrowUtilities(){
    }

    /**
     * Paint a north arrow using Java2D.
     *
     * @param rotation : map rotation, in radians
     * @param g2d : Graphics2D used to render
     * @param bounds : Rectangle where the scale must be painted
     * @param template  : north arrow template
     * @throws org.geotoolkit.display.exception.PortrayalException
     */
    public static void paint(final float rotation,
                              final Graphics2D g2d,
                              final int x, final int y,
                              final NorthArrowTemplate template) throws PortrayalException{
        paint(rotation,g2d,x,y,false,template);
    }

    /**
     * Paint a north arrow using Java2D.
     *
     * @param rotation : map rotation, in radians
     * @param g2d : Graphics2D used to render
     * @param bounds : Rectangle where the scale must be painted
     * @param template  : north arrow template
     * @throws org.geotoolkit.display.exception.PortrayalException
     */
    public static void paint(final float rotation,
                              final Graphics2D g2d,
                              final int x, final int y, final boolean svgQuality,
                              final NorthArrowTemplate template) throws PortrayalException{

        final Dimension estimation = estimate(g2d, template, false);
        final Dimension size = template.getSize();
        final Rectangle bounds = new Rectangle(size);
        int X = x;
        int Y = y;

        final BackgroundTemplate background = template.getBackground();
        if(background != null){
            final Rectangle area = new Rectangle(estimation);
            area.x = x;
            area.y = y;

            Insets insets = background.getBackgroundInsets();
            area.width += insets.left + insets.right;
            area.height += insets.top + insets.bottom;
            X += insets.left;
            Y += insets.top;

            BackgroundUtilities.paint(g2d, area, background);
        }

        bounds.x = X;
        bounds.y = Y;

        if(svgQuality){
            final Shape oldClip = g2d.getClip();
            g2d.setClip(bounds);

            g2d.translate(bounds.getCenterX(), bounds.getCenterY());
            g2d.rotate(rotation);
            template.renderImage(g2d, new java.awt.geom.Point2D.Double(0,0));
            g2d.rotate(-rotation);
            g2d.translate(-bounds.getCenterX(), -bounds.getCenterY());
            g2d.setClip(oldClip);
        }else{
            final Image img = template.getImage();
            if(img == null) return;

            final Shape oldClip = g2d.getClip();
            g2d.setClip(bounds);

            g2d.translate(bounds.getCenterX(), bounds.getCenterY());
            g2d.rotate(rotation);
            g2d.setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
            g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
            g2d.drawImage(img, -img.getWidth(null)/2, -img.getHeight(null)/2, null);

            g2d.rotate(-rotation);
            g2d.translate(-bounds.getCenterX(), -bounds.getCenterY());
            g2d.setClip(oldClip);
        }
    }

    public static Dimension estimate(final Graphics2D g, final NorthArrowTemplate template, final boolean considerBackground){
        final Dimension dim = new Dimension(0, 0);

        dim.width = template.getSize().width;
        dim.height = template.getSize().height;

        if(considerBackground && template.getBackground() != null){
            final Insets insets = template.getBackground().getBackgroundInsets();
            dim.width += insets.left + insets.right;
            dim.height += insets.bottom + insets.top;
        }

        return dim;
    }

}