net.sourceforge.plantuml.timingdiagram.graphic.TimeArrow Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.timingdiagram.graphic;
import net.sourceforge.plantuml.decoration.WithLinkType;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UDrawable;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
public class TimeArrow implements UDrawable {
private final XPoint2D start;
private final XPoint2D end;
private final Display label;
private final ISkinParam skinParam;
private final StyleBuilder styleBuilder;
private final WithLinkType type;
public static TimeArrow create(IntricatedPoint pt1, IntricatedPoint pt2, Display label, ISkinParam spriteContainer,
WithLinkType type) {
final TimeArrow arrow1 = new TimeArrow(pt1.getPointA(), pt2.getPointA(), label, spriteContainer, type);
final TimeArrow arrow2 = new TimeArrow(pt1.getPointA(), pt2.getPointB(), label, spriteContainer, type);
final TimeArrow arrow3 = new TimeArrow(pt1.getPointB(), pt2.getPointA(), label, spriteContainer, type);
final TimeArrow arrow4 = new TimeArrow(pt1.getPointB(), pt2.getPointB(), label, spriteContainer, type);
return shorter(arrow1, arrow2, arrow3, arrow4);
}
private TimeArrow(XPoint2D start, XPoint2D end, Display label, ISkinParam skinParam, WithLinkType type) {
this.start = start;
this.type = type;
this.end = end;
this.label = label;
this.skinParam = skinParam;
this.styleBuilder = skinParam.getCurrentStyleBuilder();
}
private double getAngle() {
return Math.atan2(end.getX() - start.getX(), end.getY() - start.getY());
}
private static TimeArrow shorter(TimeArrow arrow1, TimeArrow arrow2) {
if (arrow1.len() < arrow2.len()) {
return arrow1;
}
return arrow2;
}
private static TimeArrow shorter(TimeArrow arrow1, TimeArrow arrow2, TimeArrow arrow3, TimeArrow arrow4) {
return shorter(shorter(arrow1, arrow2), shorter(arrow3, arrow4));
}
private double len() {
return start.distance(end);
}
public TimeArrow translate(UTranslate translate) {
return new TimeArrow(translate.getTranslated(start), translate.getTranslated(end), label, skinParam,
type);
}
public static XPoint2D onCircle(XPoint2D pt, double alpha) {
final double radius = 8;
final double x = pt.getX() - Math.sin(alpha) * radius;
final double y = pt.getY() - Math.cos(alpha) * radius;
return new XPoint2D(x, y);
}
private FontConfiguration getFontConfiguration() {
return getStyle().getFontConfiguration(skinParam.getIHtmlColorSet());
}
public void drawU(UGraphic ug) {
final double angle = getAngle();
ug = ug.apply(type.getSpecificColor()).apply(type.getUStroke());
final ULine line = new ULine(end.getX() - start.getX(), end.getY() - start.getY());
ug.apply(UTranslate.point(start)).draw(line);
final double delta = 20.0 * Math.PI / 180.0;
final XPoint2D pt1 = onCircle(end, angle + delta);
final XPoint2D pt2 = onCircle(end, angle - delta);
final UPolygon polygon = new UPolygon();
polygon.addPoint(pt1.getX(), pt1.getY());
polygon.addPoint(pt2.getX(), pt2.getY());
polygon.addPoint(end.getX(), end.getY());
ug = ug.apply(type.getSpecificColor().bg());
ug.draw(polygon);
final TextBlock textLabel = getTextBlock(label);
double xText = (pt1.getX() + pt2.getX()) / 2;
double yText = (pt1.getY() + pt2.getY()) / 2;
if (start.getY() < end.getY()) {
final XDimension2D dimLabel = textLabel.calculateDimension(ug.getStringBounder());
yText -= dimLabel.getHeight();
}
textLabel.drawU(ug.apply(new UTranslate(xText, yText)));
}
private TextBlock getTextBlock(Display display) {
return display.create(getFontConfiguration(), HorizontalAlignment.LEFT, skinParam);
}
private Style getStyle() {
return getStyleSignature().getMergedStyle(styleBuilder);
}
private StyleSignatureBasic getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram,SName.arrow);
}
}