net.sourceforge.plantuml.timingdiagram.TimeConstraint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit 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 MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* 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 MIT license.
*
* The generated images can then be used without any reference to the MIT 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;
import java.util.List;
import java.util.Objects;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
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.font.StringBounder;
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.ULine;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.skin.ArrowConfiguration;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.utils.Direction;
public class TimeConstraint {
private final TimeTick tick1;
private final TimeTick tick2;
private final Display label;
private final ISkinParam skinParam;
private final StyleBuilder styleBuilder;
private final ArrowConfiguration config;
private final double marginx;
public TimeConstraint(double marginx, TimeTick tick1, TimeTick tick2, String label, ISkinParam skinParam,
ArrowConfiguration config) {
this.marginx = marginx;
this.tick1 = Objects.requireNonNull(tick1);
this.tick2 = Objects.requireNonNull(tick2);
this.label = Display.getWithNewlines(label);
this.skinParam = skinParam;
this.styleBuilder = skinParam.getCurrentStyleBuilder();
this.config = config;
}
public final boolean containsStrict(TimeTick other) {
return tick1.compareTo(other) < 0 && tick2.compareTo(other) > 0;
}
public final TimeTick getTick1() {
return tick1;
}
public final TimeTick getTick2() {
return tick2;
}
public final Display getLabel() {
return label;
}
private TextBlock getTextBlock(Display display) {
return display.create(getFontConfiguration(), HorizontalAlignment.LEFT, skinParam);
}
private FontConfiguration getFontConfiguration() {
return getStyle().getFontConfiguration(skinParam.getIHtmlColorSet());
}
public void drawU(UGraphic ug, TimingRuler ruler) {
final HColor arrowColor = getArrowColor();
ug = ug.apply(arrowColor).apply(arrowColor.bg());
final double x1 = ruler.getPosInPixel(tick1) + marginx;
final double x2 = ruler.getPosInPixel(tick2) - marginx;
ug = ug.apply(UTranslate.dx(x1));
final double len = x2 - x1;
ug.apply(getUStroke()).draw(ULine.hline(len));
if (len > 10) {
ug.draw(getPolygon(Direction.LEFT, new XPoint2D(0, 0)));
ug.draw(getPolygon(Direction.RIGHT, new XPoint2D(len, 0)));
} else {
ug.draw(getPolygon(Direction.RIGHT, new XPoint2D(0, 0)));
ug.draw(getPolygon(Direction.LEFT, new XPoint2D(len, 0)));
}
final TextBlock text = getTextBlock(label);
final XDimension2D dimText = text.calculateDimension(ug.getStringBounder());
final double x = (len - dimText.getWidth()) / 2;
text.drawU(ug.apply(new UTranslate(x, -getConstraintHeight(ug.getStringBounder()))));
}
private HColor getArrowColor() {
final HColor configColor = config.getColor();
if (configColor != null)
return configColor;
return getStyle().value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
}
private Style getStyle() {
return getStyleSignature().getMergedStyle(styleBuilder);
}
private UStroke getUStroke() {
return getStyle().getStroke();
}
private StyleSignatureBasic getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.constraintArrow);
}
public double getConstraintHeight(StringBounder stringBounder) {
final TextBlock text = getTextBlock(label);
final XDimension2D dimText = text.calculateDimension(stringBounder);
return dimText.getHeight() + getTopMargin();
}
public static double getTopMargin() {
return 5;
}
private UPolygon getPolygon(Direction dir, XPoint2D end) {
final double dx = 8;
final double dy = 4;
final XPoint2D pt1;
final XPoint2D pt2;
if (dir == Direction.RIGHT) {
pt1 = end.move(-dx, dy);
pt2 = end.move(-dx, -dy);
} else {
pt1 = end.move(dx, dy);
pt2 = end.move(dx, -dy);
}
final UPolygon polygon = new UPolygon();
polygon.addPoint(pt1);
polygon.addPoint(pt2);
polygon.addPoint(end);
return polygon;
}
public static double getHeightForConstraints(StringBounder stringBounder, List constraints) {
if (constraints.size() == 0)
return 0;
double result = 0;
for (TimeConstraint constraint : constraints)
result = Math.max(result, constraint.getConstraintHeight(stringBounder));
return result;
}
}