net.sourceforge.plantuml.flowdiagram.FlowDiagram 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.flowdiagram;
import static net.atmp.ImageBuilder.imageBuilder;
import java.io.IOException;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;
import net.atmp.ImageBuilder;
import net.atmp.InnerStrategy;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.UmlDiagram;
import net.sourceforge.plantuml.core.DiagramDescription;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.golem.MinMaxGolem;
import net.sourceforge.plantuml.golem.Path;
import net.sourceforge.plantuml.golem.Position;
import net.sourceforge.plantuml.golem.Tile;
import net.sourceforge.plantuml.golem.TileArea;
import net.sourceforge.plantuml.golem.TileGeometry;
import net.sourceforge.plantuml.golem.TilesField;
import net.sourceforge.plantuml.klimt.UShape;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.MagneticBorder;
import net.sourceforge.plantuml.klimt.geom.MagneticBorderNone;
import net.sourceforge.plantuml.klimt.geom.MinMax;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.geom.XRectangle2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
public class FlowDiagram extends UmlDiagram implements TextBlock {
// ::remove folder when __HAXE__
private static double SINGLE_SIZE_X = 100;
private static double SINGLE_SIZE_Y = 35;
private TilesField field;
private final Map tilesBoxes = new HashMap();
private Tile lastTile;
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
throw new UnsupportedOperationException();
}
public DiagramDescription getDescription() {
return new DiagramDescription("Flow Diagram");
}
public FlowDiagram(UmlSource source) {
super(source, UmlDiagramType.FLOW, null);
}
public void lineSimple(TileGeometry orientation, String idDest, String label) {
final Tile newTile;
if (field == null) {
field = new TilesField();
tilesBoxes.clear();
newTile = field.getRoot();
} else {
newTile = field.createTile(lastTile, orientation);
}
final ActivityBox box = new ActivityBox(newTile, idDest, label);
tilesBoxes.put(newTile, box);
lastTile = newTile;
return;
}
public void linkSimple(TileGeometry orientation, String idDest) {
final Tile tile = getTileById(idDest);
field.addPath(lastTile, tile, orientation);
}
private Tile getTileById(String id) {
for (Map.Entry ent : tilesBoxes.entrySet()) {
if (ent.getValue().getId().equals(id)) {
return ent.getKey();
}
}
throw new IllegalArgumentException(id);
}
@Override
public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption) throws IOException {
return imageBuilder(fileFormatOption)
.dimension(calculateDimension(fileFormatOption.getDefaultStringBounder(getSkinParam())))
.margin(getDefaultMargins()).metadata(fileFormatOption.isWithMetadata() ? getMetadata() : null)
.seed(seed());
}
@Override
protected ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
return createImageBuilder(fileFormatOption).drawable(this).write(os);
}
public void drawU(UGraphic ug) {
double x = 0;
double y = 0;
final MinMaxGolem minMax = getMinMax();
x -= minMax.getMinX() * SINGLE_SIZE_X;
y -= minMax.getMinY() * SINGLE_SIZE_Y;
final StringBounder stringBounder = ug.getStringBounder();
for (Map.Entry ent : tilesBoxes.entrySet()) {
final Tile tile = ent.getKey();
final Position pos = field.getPosition(tile);
final int xmin = pos.getXmin();
final int ymin = pos.getYmin();
final ActivityBox box = ent.getValue();
final XDimension2D dimBox = box.calculateDimension(stringBounder);
final double deltaX = SINGLE_SIZE_X * 2 - dimBox.getWidth();
final double deltaY = SINGLE_SIZE_Y * 2 - dimBox.getHeight();
box.drawU(ug.apply(
new UTranslate((x + xmin * SINGLE_SIZE_X + deltaX / 2), (y + ymin * SINGLE_SIZE_Y + deltaY / 2))));
}
ug = ug.apply(HColors.MY_RED);
ug = ug.apply(HColors.MY_RED.bg());
final UShape arrow = UEllipse.build(7, 7);
for (Path p : field.getPaths()) {
final TileArea start = p.getStart();
final TileArea dest = p.getDest();
final XPoint2D pStart = movePoint(getCenter(start), start.getTile(), start.getGeometry(), stringBounder);
final XPoint2D pDest = movePoint(getCenter(dest), dest.getTile(), dest.getGeometry(), stringBounder);
final ULine line = new ULine(pDest.getX() - pStart.getX(), pDest.getY() - pStart.getY());
ug.apply(new UTranslate(x + pStart.getX(), y + pStart.getY())).draw(line);
ug.apply(new UTranslate(x + pDest.getX() - 3, y + pDest.getY() - 3)).draw(arrow);
}
}
private XPoint2D getCenter(TileArea area) {
final Tile tile = area.getTile();
final Position position = field.getPosition(tile);
final double x = position.getCenterX();
final double y = position.getCenterY();
return new XPoint2D(x * SINGLE_SIZE_X, y * SINGLE_SIZE_Y);
}
private XPoint2D movePoint(XPoint2D pt, Tile tile, TileGeometry tileGeometry, StringBounder stringBounder) {
final XDimension2D dim = tilesBoxes.get(tile).calculateDimension(stringBounder);
final double width = dim.getWidth();
final double height = dim.getHeight();
double x = pt.getX();
double y = pt.getY();
switch (tileGeometry) {
case SOUTH:
y += height / 2;
break;
case NORTH:
y -= height / 2;
break;
case EAST:
x += width / 2;
break;
case WEST:
x -= width / 2;
break;
default:
throw new IllegalStateException();
}
return new XPoint2D(x, y);
}
private MinMaxGolem getMinMax() {
final MinMaxGolem minMax = new MinMaxGolem();
for (Tile tile : tilesBoxes.keySet()) {
minMax.manage(field.getPosition(tile));
}
return minMax;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
final MinMaxGolem minMax = getMinMax();
return new XDimension2D(minMax.getWidth() * SINGLE_SIZE_X, minMax.getHeight() * SINGLE_SIZE_Y);
}
public MinMax getMinMax(StringBounder stringBounder) {
throw new UnsupportedOperationException();
}
@Override
public ClockwiseTopRightBottomLeft getDefaultMargins() {
return ClockwiseTopRightBottomLeft.same(0);
}
@Override
protected TextBlock getTextBlock() {
return this;
}
@Override
public MagneticBorder getMagneticBorder() {
return new MagneticBorderNone();
}
@Override
public HColor getBackcolor() {
return null;
}
}