/**
* OrbisGIS is a java GIS application dedicated to research in GIScience.
* OrbisGIS is developed by the GIS group of the DECIDE team of the
* Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
*
* The GIS group of the DECIDE team is located at :
*
* Laboratoire Lab-STICC – CNRS UMR 6285
* Equipe DECIDE
* UNIVERSITÉ DE BRETAGNE-SUD
* Institut Universitaire de Technologie de Vannes
* 8, Rue Montaigne - BP 561 56017 Vannes Cedex
*
* OrbisGIS is distributed under GPL 3 license.
*
* Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
* Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
*
* This file is part of OrbisGIS.
*
* OrbisGIS 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.
*
* OrbisGIS 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
* OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
*
* For more information, please consult: <http://www.orbisgis.org/>
* or contact directly:
* info_at_ orbisgis.org
*/
package org.orbisgis.legend.thematic.constant;
import org.orbisgis.coremap.renderer.se.PointSymbolizer;
import org.orbisgis.coremap.renderer.se.graphic.Graphic;
import org.orbisgis.coremap.renderer.se.graphic.MarkGraphic;
import org.orbisgis.legend.structure.fill.constant.ConstantSolidFill;
import org.orbisgis.legend.structure.graphic.ConstantFormWKN;
import org.orbisgis.legend.structure.graphic.ConstantWKNLegend;
import org.orbisgis.legend.structure.stroke.constant.ConstantPenStroke;
import org.orbisgis.legend.thematic.ConstantFormPoint;
import org.orbisgis.legend.thematic.PointParameters;
import org.orbisgis.legend.thematic.uom.StrokeUom;
import org.xnap.commons.i18n.I18n;
import org.xnap.commons.i18n.I18nFactory;
import java.awt.*;
/**
* We are dealing with a simple point symbolizer. If we succeeded in recognizing
* this thematic structure, we can say many things about the underlying
* {@code PointSymbolize} :
* <ul>
* <li>It is a constant {@code MarkGraphic} instance, used with a well-known
* name rather than an external Graphic.</li>
* <li>Its contouring line is constant, made of a {@code PenStroke} with a
* {@code SolidFill} of fixed colour and width.</li>
* <li>It is filled with a {@code SolidFill} of fixed colour and opacity.</li>
* <li>the width and height of its {@code ViewBox} are constant.</li>
* </ul>
* @author Alexis Guéganno
*/
public class UniqueSymbolPoint extends ConstantFormPoint implements IUniqueSymbolArea {
private ConstantWKNLegend markGraphic;
private static final I18n I18N = I18nFactory.getI18n(UniqueSymbolPoint.class);
public static final String NAME = I18N.tr("Unique Symbol - Point");
/**
* Build a new {@code UniqueSymbolPoint} from scratch. It will instanciate
* the inner symbolizer as needed, as well as the underlying {@code LegendStructure}
* structure.</p>
* <p>We basically instanciate a new default {@code PointSymbolizer}, and
* use it to compute our {@code LegendStructure} structure. That means we know
* everything but the colour about the {@code Symbolizer}. And we can be
* sure it is a constant.
*/
public UniqueSymbolPoint() {
super(new PointSymbolizer());
Graphic gr = ((PointSymbolizer) getSymbolizer()).getGraphicCollection().getGraphic(0);
markGraphic = new ConstantWKNLegend((MarkGraphic)gr);
}
/**
* Tries to build an instance of {@code UniqueSymbolPoint} using the given
* {@code PointSymbolizer}.
* @param pointSymbolizer The original symbolizer
* @throws IllegalArgumentException
* If {@code pointSymbolizer} can't be recognized as a valid {@code
* UniqueSymbolPoint}.
*/
public UniqueSymbolPoint(PointSymbolizer pointSymbolizer) {
super(pointSymbolizer);
//A UniqueSymbolPoint is mainly a constant and simple MarkGraphicLegend.
if(pointSymbolizer.getGraphicCollection().getNumGraphics() == 1){
Graphic gr = pointSymbolizer.getGraphicCollection().getGraphic(0);
if(gr instanceof MarkGraphic){
markGraphic = new ConstantWKNLegend((MarkGraphic)gr);
}
setViewBoxHeight(getViewBoxHeight());
setViewBoxWidth(getViewBoxWidth());
} else {
throw new IllegalArgumentException("We can't analyze symbolizers with"
+ "graphic collections.");
}
}
/**
* Builds a new {@code UniqueSymbolPoint} using the configuration given in argument
* @param pp The point configuration with all parameters gathered in a {@code PointParameters} instance.
*/
public UniqueSymbolPoint(PointParameters pp){
this();
getPenStroke().setDashArray(pp.getLineDash());
getPenStroke().setLineColor(pp.getLineColor());
getPenStroke().setLineOpacity(pp.getLineOpacity());
getPenStroke().setLineWidth(pp.getLineWidth());
getFillLegend().setColor(pp.getFillColor());
getFillLegend().setOpacity(pp.getFillOpacity());
setViewBoxWidth(pp.getWidth());
setViewBoxHeight(pp.getHeight());
setWellKnownName(pp.getWkn());
}
/**
* Create a new {@code UniqueSymbolPoint}. As the associated analysis is
* given in parameter, it is up to the calling method to be sure that
* @param symbolizer the original symbolizer
* @param markGraphic its associated legend
*/
public UniqueSymbolPoint(PointSymbolizer symbolizer, ConstantWKNLegend markGraphic) {
super(symbolizer);
this.markGraphic = markGraphic;
}
@Override
public ConstantFormWKN getMarkGraphic() {
return markGraphic;
}
@Override
public ConstantSolidFill getFillLegend() {
return markGraphic.getSolidFill();
}
@Override
public void setFillLegend(ConstantSolidFill csf) {
markGraphic.setFillLegend(csf);
}
@Override
public ConstantPenStroke getPenStroke(){
return markGraphic.getPenStroke();
}
@Override
public void setPenStroke(ConstantPenStroke cpsl) {
markGraphic.setPenStroke(cpsl);
}
/**
* Get the width of the {@code ViewBox} we are going to draw our symbol in.
* @return
* A {@code Double} that can be null. A {@code ViewBox} can be defined with
* only one dimension set.
*/
public Double getViewBoxWidth(){
return markGraphic.getViewBoxWidth();
}
/**
* Get the height of the {@code ViewBox} we are going to draw our symbol in.
* @return
* A {@code Double} that can be null. A {@code ViewBox} can be defined with
* only one dimension set.
*/
public Double getViewBoxHeight(){
return markGraphic.getViewBoxHeight();
}
/**
* Set the height of the {@code ViewBox} we are going to draw our symbol in.
* @param d
* A {@code Double} that can be null. A {@code ViewBox} can be defined with
* only one dimension set.
*/
public void setViewBoxHeight(Double d) {
markGraphic.setViewBoxHeight(d);
}
/**
* Set the width of the {@code ViewBox} we are going to draw our symbol in.
* @param d
* A {@code Double} that can be null. A {@code ViewBox} can be defined with
* only one dimension set.
*/
public void setViewBoxWidth(Double d) {
markGraphic.setViewBoxWidth(d);
}
@Override
public String getLegendTypeName() {
return NAME;
}
@Override
public String getLegendTypeId(){
return "org.orbisgis.legend.thematic.constant.UniqueSymbolPoint";
}
/**
* Gets the configuration defining this point, uom excluded, as a {@link PointParameters} instance.
* @return This point as a {@code PointParameters}.
*/
public PointParameters getPointParameters() {
ConstantPenStroke cps = getPenStroke();
Double lw=cps.getLineWidth();
Double lop = cps.getLineOpacity();
Color lCol = cps.getLineColor();
String lDash = cps.getDashArray();
ConstantSolidFill csf = getFillLegend();
return new PointParameters(lCol,
lop,
lw,
lDash,
csf.getColor(),
csf.getOpacity(),
getViewBoxWidth(),
getViewBoxHeight(),
getWellKnownName());
}
}