net.sourceforge.plantuml.svek.image.EntityImageNote 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.svek.image;
import java.util.EnumMap;
import java.util.Map;
import java.util.Objects;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.cucadiagram.BodyFactory;
import net.sourceforge.plantuml.klimt.UGroupType;
import net.sourceforge.plantuml.klimt.UPath;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.ColorType;
import net.sourceforge.plantuml.klimt.color.Colors;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.creole.Stencil;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.drawing.UGraphicStencil;
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.XLine2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.DotPath;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockEmpty;
import net.sourceforge.plantuml.sdot.SmetanaPath;
import net.sourceforge.plantuml.skin.ColorParam;
import net.sourceforge.plantuml.skin.CornerParam;
import net.sourceforge.plantuml.skin.SkinParamBackcolored;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.stereo.Stereotype;
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.StyleSignature;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.svek.AbstractEntityImage;
import net.sourceforge.plantuml.svek.ShapeType;
import net.sourceforge.plantuml.svek.SvekLine;
import net.sourceforge.plantuml.svek.SvekNode;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.utils.Direction;
public class EntityImageNote extends AbstractEntityImage implements Stencil {
private final HColor noteBackgroundColor;
private final HColor borderColor;
private final double shadowing;
private final int marginX1 = 6;
private final int marginX2 = 15;
private final int marginY = 5;
private final ISkinParam skinParam;
private final Style style;
private final TextBlock textBlock;
public EntityImageNote(Entity entity, ISkinParam skinParam, UmlDiagramType umlDiagramType) {
super(entity, getSkin(getISkinParam(skinParam, entity), entity));
this.skinParam = getISkinParam(skinParam, entity);
final Display strings = entity.getDisplay();
this.style = getDefaultStyleDefinition(umlDiagramType.getStyleName())
.getMergedStyle(skinParam.getCurrentStyleBuilder());
if (entity.getColors().getColor(ColorType.BACK) == null)
this.noteBackgroundColor = style.value(PName.BackGroundColor).asColor(skinParam.getIHtmlColorSet());
else
this.noteBackgroundColor = entity.getColors().getColor(ColorType.BACK);
this.borderColor = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
this.shadowing = style.value(PName.Shadowing).asDouble();
final FontConfiguration fontConfiguration = style.getFontConfiguration(skinParam.getIHtmlColorSet());
final HorizontalAlignment horizontalAlignment = style.getHorizontalAlignment();
if (strings.size() == 1 && strings.get(0).length() == 0)
textBlock = new TextBlockEmpty();
else
textBlock = BodyFactory.create3(strings, getSkinParam(), horizontalAlignment, fontConfiguration,
style.wrapWidth(), style);
}
private static ISkinParam getISkinParam(ISkinParam skinParam, Entity entity) {
if (entity.getColors() != null)
return entity.getColors().mute(skinParam);
return skinParam;
}
static ISkinParam getSkin(ISkinParam skinParam, Entity entity) {
final Stereotype stereotype = entity.getStereotype();
HColor back = entity.getColors().getColor(ColorType.BACK);
if (back != null)
return new SkinParamBackcolored(skinParam, back);
back = getColorStatic(skinParam, ColorParam.noteBackground, stereotype);
if (back != null)
return new SkinParamBackcolored(skinParam, back);
return skinParam;
}
private static HColor getColorStatic(ISkinParam skinParam, ColorParam colorParam, Stereotype stereo) {
final Rose rose = new Rose();
return rose.getHtmlColor(skinParam, stereo, colorParam);
}
final public double getPreferredWidth(StringBounder stringBounder) {
final double result = getTextWidth(stringBounder);
return result;
}
final public double getPreferredHeight(StringBounder stringBounder) {
return getTextHeight(stringBounder);
}
private XDimension2D getSize(StringBounder stringBounder, final TextBlock textBlock) {
return textBlock.calculateDimension(stringBounder);
}
final protected double getTextHeight(StringBounder stringBounder) {
final TextBlock textBlock = getTextBlock();
final XDimension2D size = getSize(stringBounder, textBlock);
return size.getHeight() + 2 * marginY;
}
final protected TextBlock getTextBlock() {
return textBlock;
}
final protected double getPureTextWidth(StringBounder stringBounder) {
final TextBlock textBlock = getTextBlock();
final XDimension2D size = getSize(stringBounder, textBlock);
return size.getWidth();
}
final public double getTextWidth(StringBounder stringBounder) {
return getPureTextWidth(stringBounder) + marginX1 + marginX2;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
final double height = getPreferredHeight(stringBounder);
final double width = getPreferredWidth(stringBounder);
return new XDimension2D(width, height);
}
private StyleSignature getDefaultStyleDefinition(SName sname) {
return StyleSignatureBasic.of(SName.root, SName.element, sname, SName.note).withTOBECHANGED(getStereo());
}
final public void drawU(UGraphic ug) {
final Url url = getEntity().getUrl99();
final Map typeIDent = new EnumMap<>(UGroupType.class);
typeIDent.put(UGroupType.CLASS, "elem " + getEntity().getName() + " selected");
typeIDent.put(UGroupType.ID, "elem_" + getEntity().getName());
ug.startGroup(typeIDent);
if (url != null)
ug.startUrl(url);
final UGraphic ug2 = UGraphicStencil.create(ug, this, UStroke.simple());
if (opaleLink != null) {
final StringBounder stringBounder = ug.getStringBounder();
final SmetanaPath smetanaEdged = smetanaPathes.get(opaleLink);
final UTranslate move = new UTranslate(-node.getMinX(), -node.getMinY());
final XPoint2D startPoint = move.getTranslated(smetanaEdged.getStartPoint());
final XPoint2D endPoint = move.getTranslated(smetanaEdged.getEndPoint());
final UTranslate force1 = getMagneticBorder().getForceAt(stringBounder, smetanaEdged.getStartPoint());
final UTranslate force2 = other.getMagneticBorder().getForceAt(stringBounder, smetanaEdged.getEndPoint());
final double textWidth = getTextWidth(stringBounder);
final double textHeight = getTextHeight(stringBounder);
final XPoint2D center = new XPoint2D(textWidth / 2, textHeight / 2);
XPoint2D pp1 = force2.getTranslated(startPoint);
XPoint2D pp2 = force1.getTranslated(endPoint);
if (pp1.distance(center) < pp2.distance(center)) {
pp1 = force1.getTranslated(endPoint);
pp2 = force2.getTranslated(startPoint);
}
final Direction strategy = getOpaleStrategy(textWidth, textHeight, pp2);
final Opale opale = new Opale(shadowing, borderColor, noteBackgroundColor, textBlock, true, getStroke());
opale.setRoundCorner(getRoundCorner());
opale.setOpale(strategy, pp2, pp1);
final UGraphic stroked = applyStroke(ug2);
opale.drawU(Colors.applyStroke(stroked, getEntity().getColors()));
} else if (opaleLine == null || opaleLine.isOpale() == false) {
drawNormal(ug2);
} else {
final StringBounder stringBounder = ug.getStringBounder();
DotPath path = opaleLine.getDotPath();
final UTranslate force1 = getMagneticBorder().getForceAt(stringBounder, path.getStartPoint());
final UTranslate force2 = other.getMagneticBorder().getForceAt(stringBounder, path.getEndPoint());
path.moveSvek(-node.getMinX(), -node.getMinY());
final double textWidth = getTextWidth(stringBounder);
final double textHeight = getTextHeight(stringBounder);
final XPoint2D center = new XPoint2D(textWidth / 2, textHeight / 2);
if (path.getStartPoint().distance(center) > path.getEndPoint().distance(center))
path = path.reverse();
final Direction strategy = getOpaleStrategy(textWidth, textHeight, path.getStartPoint());
final XPoint2D pp1 = force1.getTranslated(path.getStartPoint());
final XPoint2D pp2 = force2.getTranslated(path.getEndPoint());
final Opale opale = new Opale(shadowing, borderColor, noteBackgroundColor, textBlock, true, getStroke());
opale.setRoundCorner(getRoundCorner());
opale.setOpale(strategy, pp1, pp2);
final UGraphic stroked = applyStroke(ug2);
opale.drawU(Colors.applyStroke(stroked, getEntity().getColors()));
}
if (url != null)
ug.closeUrl();
ug.closeGroup();
}
private double getRoundCorner() {
return skinParam.getRoundCorner(CornerParam.DEFAULT, null);
}
private void drawNormal(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final UPath polygon = Opale.getPolygonNormal(getTextWidth(stringBounder), getTextHeight(stringBounder),
getRoundCorner());
polygon.setDeltaShadow(this.shadowing);
ug = ug.apply(noteBackgroundColor.bg()).apply(borderColor);
final UGraphic stroked = applyStroke(ug);
stroked.draw(polygon);
ug.draw(Opale.getCorner(getTextWidth(stringBounder), getRoundCorner()));
getTextBlock().drawU(ug.apply(new UTranslate(marginX1, marginY)));
}
private UGraphic applyStroke(UGraphic ug) {
return ug.apply(style.getStroke());
}
private UStroke getStroke() {
return style.getStroke();
}
private Direction getOpaleStrategy(double width, double height, XPoint2D pt) {
final double d1 = getOrthoDistance(new XLine2D(width, 0, width, height), pt);
final double d2 = getOrthoDistance(new XLine2D(0, height, width, height), pt);
final double d3 = getOrthoDistance(new XLine2D(0, 0, 0, height), pt);
final double d4 = getOrthoDistance(new XLine2D(0, 0, width, 0), pt);
if (d3 <= d1 && d3 <= d2 && d3 <= d4)
return Direction.LEFT;
if (d1 <= d2 && d1 <= d3 && d1 <= d4)
return Direction.RIGHT;
if (d4 <= d1 && d4 <= d2 && d4 <= d3)
return Direction.UP;
if (d2 <= d1 && d2 <= d3 && d2 <= d4)
return Direction.DOWN;
return null;
}
private static double getOrthoDistance(XLine2D seg, XPoint2D pt) {
if (isHorizontal(seg))
return Math.abs(seg.getP1().getY() - pt.getY());
if (isVertical(seg))
return Math.abs(seg.getP1().getX() - pt.getX());
throw new IllegalArgumentException();
}
private static boolean isHorizontal(XLine2D seg) {
return seg.getP1().getY() == seg.getP2().getY();
}
private static boolean isVertical(XLine2D seg) {
return seg.getP1().getX() == seg.getP2().getX();
}
public ShapeType getShapeType() {
return ShapeType.RECTANGLE;
}
private SvekLine opaleLine;
private Link opaleLink;
private SvekNode node;
private SvekNode other;
private Map smetanaPathes;
public void setOpaleLine(SvekLine line, SvekNode node, SvekNode other) {
this.opaleLine = line;
this.node = node;
this.other = Objects.requireNonNull(other);
}
public void setOpaleLink(Link link, SvekNode node, SvekNode other, Map edges) {
this.opaleLink = link;
this.node = node;
this.other = Objects.requireNonNull(other);
this.smetanaPathes = edges;
}
public double getStartingX(StringBounder stringBounder, double y) {
return 0;
}
public double getEndingX(StringBounder stringBounder, double y) {
return calculateDimension(stringBounder).getWidth();
}
}