net.sourceforge.plantuml.activitydiagram3.ftile.Snake 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.activitydiagram3.ftile;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import net.sourceforge.plantuml.decoration.HtmlColorAndStyle;
import net.sourceforge.plantuml.decoration.Rainbow;
import net.sourceforge.plantuml.klimt.UShape;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.compress.PiecewiseAffineTransform;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.MinMax;
import net.sourceforge.plantuml.klimt.geom.VerticalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XLine2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.utils.Direction;
public class Snake implements UShape {
static class Text {
private final TextBlock textBlock;
private final VerticalAlignment verticalAlignment;
private final HorizontalAlignment horizontalAlignment;
Text(TextBlock textBlock, VerticalAlignment verticalAlignment, HorizontalAlignment horizontalAlignment) {
this.textBlock = Objects.requireNonNull(textBlock);
this.verticalAlignment = verticalAlignment;
this.horizontalAlignment = horizontalAlignment;
}
private boolean hasText(StringBounder stringBounder) {
return TextBlockUtils.isEmpty(this.textBlock, stringBounder) == false;
}
}
private final Worm worm;
private final UPolygon startDecoration;
private final UPolygon endDecoration;
private final Rainbow color;
private final List texts;
private final MergeStrategy mergeable;
private final Direction emphasizeDirection;
private final ISkinParam skinParam;
public Snake transformX(PiecewiseAffineTransform compressionTransform) {
final Snake result = cloneEmpty();
for (XPoint2D pt : worm) {
final double x = compressionTransform.transform(pt.x);
final double y = pt.y;
result.addPoint(x, y);
}
return result;
}
public Snake move(double dx, double dy) {
final Snake result = cloneEmpty();
for (XPoint2D pt : worm)
result.addPoint(pt.getX() + dx, pt.getY() + dy);
return result;
}
private Snake cloneEmpty() {
return new Snake(skinParam, startDecoration, color, endDecoration, worm.cloneEmpty(), mergeable,
emphasizeDirection, texts);
}
public final Snake ignoreForCompression() {
this.worm.setIgnoreForCompression();
return this;
}
public Snake emphasizeDirection(Direction emphasizeDirection) {
return new Snake(skinParam, startDecoration, color, endDecoration, worm, mergeable, emphasizeDirection, texts);
}
public Snake withoutEndDecoration() {
return new Snake(skinParam, startDecoration, color, null, worm, mergeable, emphasizeDirection, texts);
}
public Snake withMerge(MergeStrategy mergeable) {
return new Snake(skinParam, startDecoration, color, endDecoration, worm, mergeable, emphasizeDirection, texts);
}
public Snake withLabel(TextBlock textBlock, HorizontalAlignment horizontalAlignment) {
if (textBlock != null)
this.texts.add(new Text(textBlock, null, horizontalAlignment));
return this;
}
public Snake withLabel(TextBlock textBlock, VerticalAlignment verticalAlignment) {
if (textBlock != null && textBlock != TextBlockUtils.EMPTY_TEXT_BLOCK)
this.texts.add(new Text(textBlock, verticalAlignment, null));
return this;
}
public static Snake create(ISkinParam skinParam, Rainbow color) {
final Style style = StyleSignatureBasic.activityArrow().getMergedStyle(skinParam.getCurrentStyleBuilder());
return new Snake(skinParam, null, color, null, new Worm(style, skinParam.arrows()), MergeStrategy.FULL, null,
new ArrayList());
}
public static Snake create(ISkinParam skinParam, Rainbow color, UPolygon endDecoration) {
final Style style = StyleSignatureBasic.activityArrow().getMergedStyle(skinParam.getCurrentStyleBuilder());
return new Snake(skinParam, null, color, endDecoration, new Worm(style, skinParam.arrows()), MergeStrategy.FULL,
null, new ArrayList());
}
public static Snake create(ISkinParam skinParam, UPolygon startDecoration, Rainbow color, UPolygon endDecoration) {
final Style style = StyleSignatureBasic.activityArrow().getMergedStyle(skinParam.getCurrentStyleBuilder());
return new Snake(skinParam, startDecoration, color, endDecoration, new Worm(style, skinParam.arrows()),
MergeStrategy.FULL, null, new ArrayList());
}
private Snake(ISkinParam skinParam, UPolygon startDecoration, Rainbow color, UPolygon endDecoration, Worm worm,
MergeStrategy mergeable, Direction emphasizeDirection, List texts) {
if (Objects.requireNonNull(color).size() == 0)
throw new IllegalArgumentException();
this.skinParam = skinParam;
this.worm = worm;
this.texts = Objects.requireNonNull(texts);
this.emphasizeDirection = emphasizeDirection;
this.startDecoration = startDecoration;
this.endDecoration = endDecoration;
this.color = color;
this.mergeable = mergeable;
}
public Snake translate(UTranslate translate) {
return move(translate.getDx(), translate.getDy());
}
@Override
public String toString() {
return worm.toString();
}
public void addPoint(double x, double y) {
worm.addPoint(x, y);
}
public void addPoint(XPoint2D p) {
addPoint(p.getX(), p.getY());
}
public void drawInternal(UGraphic ug) {
if (color.size() > 1) {
drawRainbow(ug);
} else {
worm.drawInternalOneColor(startDecoration, ug, color.getColors().get(0), 1.5, emphasizeDirection,
endDecoration);
drawInternalLabel(ug);
}
}
private void drawRainbow(UGraphic ug) {
List colors = color.getColors();
final int colorArrowSeparationSpace = color.getColorArrowSeparationSpace();
final double move = 2 + colorArrowSeparationSpace;
final WormMutation mutation = WormMutation.create(worm, move);
if (mutation.isDxNegative()) {
colors = new ArrayList<>(colors);
Collections.reverse(colors);
}
final double globalMove = -1.0 * (colors.size() - 1) / 2.0;
Worm current = worm.moveFirstPoint(mutation.getFirst().multiplyBy(globalMove));
if (mutation.size() > 2)
current = current.moveLastPoint(mutation.getLast().multiplyBy(globalMove));
for (int i = 0; i < colors.size(); i++) {
double stroke = 1.5;
if (colorArrowSeparationSpace == 0)
stroke = i == colors.size() - 1 ? 2.0 : 3.0;
current.drawInternalOneColor(startDecoration, ug, colors.get(i), stroke, emphasizeDirection, endDecoration);
current = mutation.mute(current);
}
final UTranslate textTranslate = mutation.getTextTranslate(colors.size());
drawInternalLabel(ug.apply(textTranslate));
}
private void drawInternalLabel(UGraphic ug) {
for (Text text : texts)
if (text.hasText(ug.getStringBounder())) {
final XPoint2D position = getTextBlockPosition(ug.getStringBounder(), text);
text.textBlock.drawU(ug.apply(UTranslate.point(position)));
}
}
public double getMaxX(StringBounder stringBounder) {
double result = -Double.MAX_VALUE;
for (XPoint2D pt : worm)
result = Math.max(result, pt.getX());
for (Text text : texts) {
final XPoint2D position = getTextBlockPosition(stringBounder, text);
final XDimension2D dim = text.textBlock.calculateDimension(stringBounder);
result = Math.max(result, position.getX() + dim.getWidth());
}
return result;
}
private XPoint2D getTextBlockPosition(StringBounder stringBounder, Text text) {
final XPoint2D pt1 = worm.get(0);
final XPoint2D pt2 = worm.get(1);
final XDimension2D dim = text.textBlock.calculateDimension(stringBounder);
double x = Math.max(pt1.getX(), pt2.getX()) + 4;
final boolean zigzag = worm.getDirectionsCode().startsWith("DLD") || worm.getDirectionsCode().startsWith("DRD");
double y = (pt1.getY() + pt2.getY()) / 2 - dim.getHeight() / 2;
if (text.verticalAlignment == VerticalAlignment.BOTTOM) {
x = worm.getMinX();
y = worm.getMaxY();
} else if (text.verticalAlignment == VerticalAlignment.CENTER) {
x = worm.getMinX();
y = (worm.getFirst().getY() + worm.getLast().getY() - 10) / 2 - dim.getHeight() / 2;
} else if (text.horizontalAlignment == HorizontalAlignment.CENTER && zigzag) {
final XPoint2D pt3 = worm.get(2);
x = (pt2.getX() + pt3.getX()) / 2 - dim.getWidth() / 2;
} else if (text.horizontalAlignment == HorizontalAlignment.RIGHT && zigzag) {
x = Math.max(pt1.getX(), pt2.getX()) - dim.getWidth() - 4;
} else if (worm.getDirectionsCode().equals("RD")) {
x = Math.max(pt1.getX(), pt2.getX());
y = (pt1.getY() + worm.get(2).getY()) / 2 - dim.getHeight() / 2;
} else if (worm.getDirectionsCode().equals("LD")) {
x = Math.min(pt1.getX(), pt2.getX());
y = (pt1.getY() + worm.get(2).getY()) / 2 - dim.getHeight() / 2;
}
return new XPoint2D(x, y);
}
public List getHorizontalLines() {
final List result = new ArrayList<>();
for (int i = 0; i < worm.size() - 1; i++) {
final XPoint2D pt1 = worm.get(i);
final XPoint2D pt2 = worm.get(i + 1);
if (pt1.getY() == pt2.getY()) {
final XLine2D line = XLine2D.line(pt1, pt2);
result.add(line);
}
}
return result;
}
private XPoint2D getFirst() {
return worm.get(0);
}
public XPoint2D getLast() {
return worm.get(worm.size() - 1);
}
static boolean same(XPoint2D pt1, XPoint2D pt2) {
return pt1.distance(pt2) < 0.001;
}
public Snake merge(Snake other, StringBounder stringBounder) {
final MergeStrategy strategy = this.mergeable.max(other.mergeable);
if (strategy == MergeStrategy.NONE)
return null;
for (Text text : other.texts)
if (text.hasText(stringBounder))
return null;
if (same(this.getLast(), other.getFirst())) {
final UPolygon oneOf = other.endDecoration == null ? endDecoration : other.endDecoration;
if (this.startDecoration != null || other.startDecoration != null)
throw new UnsupportedOperationException("Not yet coded: to be done");
final ArrayList mergeTexts = new ArrayList(this.texts);
mergeTexts.addAll(other.texts);
final Snake result = new Snake(skinParam, null, color, oneOf, this.worm.merge(other.worm, strategy),
strategy, emphasizeDirection == null ? other.emphasizeDirection : emphasizeDirection, mergeTexts);
return result;
}
if (same(this.getFirst(), other.getLast()))
return other.merge(this, stringBounder);
return null;
}
public boolean touches(Snake other) {
if (other.mergeable != MergeStrategy.FULL)
return false;
if (other.worm.isPureHorizontal())
return false;
return same(this.getLast(), other.getFirst());
}
public boolean doesHorizontalCross(MinMax minMax) {
return worm.doesHorizontalCross(minMax);
}
}