NonPlanarPolygonNormalsDeviation.java

/*-
 *  Copyright 2020 Beuth Hochschule für Technik Berlin, Hochschule für Technik Stuttgart
 * 
 *  This file is part of CityDoctor2.
 *
 *  CityDoctor2 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, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  CityDoctor2 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.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with CityDoctor2.  If not, see <https://www.gnu.org/licenses/>.
 */
package de.hft.stuttgart.citydoctor2.check.error;

import java.util.Optional;

import org.citygml4j.model.gml.measures.Angle;

import de.hft.stuttgart.citydoctor2.check.CheckError;
import de.hft.stuttgart.citydoctor2.check.ErrorId;
import de.hft.stuttgart.citydoctor2.check.ErrorReport;
import de.hft.stuttgart.citydoctor2.check.ErrorType;
import de.hft.stuttgart.citydoctor2.check.ErrorVisitor;
import de.hft.stuttgart.citydoctor2.check.HealingMethod;
import de.hft.stuttgart.citydoctor2.check.ModificationListener;
import de.hft.stuttgart.citydoctor2.datastructure.GmlElement;
import de.hft.stuttgart.citydoctor2.datastructure.Polygon;
import de.hft.stuttgart.quality.model.NonPlanarNormalsDeviation;
import de.hft.stuttgart.quality.model.ValidationError;

/**
 * When the normal of the triangles created from the triangulation of the
 * polygon have a too large angle between them, this error is created.
 * 
 * @author Matthias Betz
 *
 */
public class NonPlanarPolygonNormalsDeviation implements CheckError {

	private static final long serialVersionUID = 69073161885265794L;
	
	private Polygon p;
	private double deviation;

	public NonPlanarPolygonNormalsDeviation(Polygon p, double deviation) {
		this.p = p;
		this.deviation = deviation;
	}

	public Polygon getPolygon() {
		return p;
	}

	public double getDeviation() {
		return deviation;
	}

	@Override
	public void report(ErrorReport report) {
		report.add(p);
		report.add("normal deviation (in rad)", deviation);
	}

	@Override
	public void accept(ErrorVisitor errorVisitor) {
		errorVisitor.visit(this);
	}

	@Override
	public boolean accept(HealingMethod method, ModificationListener l) {
		return method.visit(this, l);
	}

	@Override
	public String toString() {
		return "NormalDeviationError [p=" + p + ", deviation=" + deviation + "]";
	}

	@Override
	public ErrorType getType() {
		return ErrorType.ERROR;
	}

	@Override
	public ErrorId getErrorId() {
		return ErrorId.GE_P_NON_PLANAR_POLYGON_NORMALS_DEVIATION;
	}

	@Override
	public GmlElement getFeature() {
		return getPolygon();
	}

	@Override
	public Optional<ValidationError> convertToQualityAdeDatastructure() {
		NonPlanarNormalsDeviation err = new NonPlanarNormalsDeviation();
		err.setPolygonId(p.getGmlId().getGmlString());
		Angle a = new Angle(deviation);
		a.setUom("rad");
		err.setDeviation(a);
		return Optional.of(err);
	}
}