net.sourceforge.plantuml.svek.image.EntityImageUseCase 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.svek.image;
import java.util.EnumMap;
import java.util.Map;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.EntityPortion;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.cucadiagram.BodyFactory;
import net.sourceforge.plantuml.cucadiagram.PortionShower;
import net.sourceforge.plantuml.klimt.UGroupType;
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.AbstractUGraphicHorizontalLine;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.FontParam;
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.TextBlockInEllipse;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.UHorizontalLine;
import net.sourceforge.plantuml.klimt.shape.ULine;
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.text.Guillemet;
import net.sourceforge.plantuml.url.Url;
public class EntityImageUseCase extends AbstractEntityImage {
final private TextBlock desc;
final private Url url;
public EntityImageUseCase(Entity entity, ISkinParam skinParam2, PortionShower portionShower) {
super(entity, entity.getColors().mute(skinParam2));
final Stereotype stereotype = entity.getStereotype();
final Style style = getStyle();
final HorizontalAlignment align = style.getHorizontalAlignment();
final TextBlock tmp = BodyFactory.create2(getSkinParam().getDefaultTextAlignment(align), entity.getDisplay(),
getSkinParam(), stereotype, entity, getStyle());
if (stereotype == null || stereotype.getLabel(Guillemet.DOUBLE_COMPARATOR) == null
|| portionShower.showPortion(EntityPortion.STEREOTYPE, entity) == false) {
this.desc = tmp;
} else {
final TextBlock stereo;
if (stereotype.getSprite(getSkinParam()) != null) {
stereo = stereotype.getSprite(getSkinParam());
} else {
stereo = Display.getWithNewlines(stereotype.getLabel(getSkinParam().guillemet())).create(
FontConfiguration.create(getSkinParam(), FontParam.USECASE_STEREOTYPE, stereotype),
HorizontalAlignment.CENTER, getSkinParam());
}
this.desc = TextBlockUtils.mergeTB(stereo, tmp, HorizontalAlignment.CENTER);
}
this.url = entity.getUrl99();
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new TextBlockInEllipse(desc, stringBounder).calculateDimension(stringBounder);
}
final public void drawU(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final Style style = getStyle();
final double shadow = style.value(PName.Shadowing).asDouble();
final TextBlockInEllipse ellipse = new TextBlockInEllipse(desc, stringBounder);
ellipse.setDeltaShadow(shadow);
if (url != null)
ug.startUrl(url);
ug = ug.apply(getStyle().getStroke(getEntity().getColors()));
final HColor linecolor = getLineColor();
ug = ug.apply(linecolor);
final HColor backcolor = getBackColor();
ug = ug.apply(backcolor.bg());
final UGraphic ug2 = new MyUGraphicEllipse(ug, 0, 0, ellipse.getUEllipse());
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);
ellipse.drawU(ug2);
ug2.closeGroup();
if (getEntity().getLeafType() == LeafType.USECASE_BUSINESS)
specialBusiness(ug, ellipse.getUEllipse());
if (url != null)
ug.closeUrl();
}
private void specialBusiness(UGraphic ug, UEllipse frontier) {
final RotatedEllipse rotatedEllipse = new RotatedEllipse(frontier, Math.PI / 4);
final double theta1 = 20.0 * Math.PI / 180;
final double theta2 = rotatedEllipse.getOtherTheta(theta1);
final UEllipse frontier2 = frontier.scale(0.99);
final XPoint2D p1 = frontier2.getPointAtAngle(-theta1);
final XPoint2D p2 = frontier2.getPointAtAngle(-theta2);
drawLine(ug, p1, p2);
}
private void specialBusiness0(UGraphic ug, UEllipse frontier) {
final double c = frontier.getWidth() / frontier.getHeight();
final double ouverture = Math.PI / 2;
final XPoint2D p1 = frontier.getPointAtAngle(getTrueAngle(c, Math.PI / 4 - ouverture));
final XPoint2D p2 = frontier.getPointAtAngle(getTrueAngle(c, Math.PI / 4 + ouverture));
drawLine(ug, p1, p2);
}
private void drawLine(UGraphic ug, final XPoint2D p1, final XPoint2D p2) {
ug = ug.apply(UTranslate.point(p1));
ug.draw(new ULine(p2.getX() - p1.getX(), p2.getY() - p1.getY()));
}
private double getTrueAngle(final double c, final double gamma) {
return Math.atan2(Math.sin(gamma), Math.cos(gamma) / c);
}
private HColor getBackColor() {
HColor backcolor = getEntity().getColors().getColor(ColorType.BACK);
if (backcolor == null) {
final Colors colors = getEntity().getColors();
Style style = getStyle();
style = style.eventuallyOverride(colors);
backcolor = style.value(PName.BackGroundColor).asColor(getSkinParam().getIHtmlColorSet());
}
return backcolor;
}
private Style getStyle() {
return getDefaultStyleDefinition().getMergedStyle(getSkinParam().getCurrentStyleBuilder());
}
private StyleSignature getDefaultStyleDefinition() {
final LeafType type = getEntity().getLeafType();
if (type == LeafType.USECASE_BUSINESS)
return StyleSignatureBasic
.of(SName.root, SName.element, SName.componentDiagram, SName.usecase, SName.business)
.withTOBECHANGED(getStereo());
return StyleSignatureBasic.of(SName.root, SName.element, SName.componentDiagram, SName.usecase)
.withTOBECHANGED(getStereo());
}
private HColor getLineColor() {
HColor linecolor = getEntity().getColors().getColor(ColorType.LINE);
if (linecolor == null) {
final Style style = getStyle();
linecolor = style.value(PName.LineColor).asColor(getSkinParam().getIHtmlColorSet());
}
return linecolor;
}
public ShapeType getShapeType() {
return ShapeType.OVAL;
}
static class MyUGraphicEllipse extends AbstractUGraphicHorizontalLine {
private final double startingX;
private final double yTheoricalPosition;
private final UEllipse ellipse;
@Override
protected AbstractUGraphicHorizontalLine copy(UGraphic ug) {
return new MyUGraphicEllipse(ug, startingX, yTheoricalPosition, ellipse);
}
MyUGraphicEllipse(UGraphic ug, double startingX, double yTheoricalPosition, UEllipse ellipse) {
super(ug);
this.startingX = startingX;
this.ellipse = ellipse;
this.yTheoricalPosition = yTheoricalPosition;
}
private double getNormalized(double y) {
if (y < yTheoricalPosition)
throw new IllegalArgumentException();
y = y - yTheoricalPosition;
if (y > ellipse.getHeight())
throw new IllegalArgumentException();
return y;
}
private double getStartingXInternal(double y) {
return startingX + ellipse.getStartingX(getNormalized(y));
}
private double getEndingXInternal(double y) {
return startingX + ellipse.getEndingX(getNormalized(y));
}
private Stencil getStencil2(UTranslate translate) {
final double dy = translate.getDy();
return new Stencil() {
public double getStartingX(StringBounder stringBounder, double y) {
return getStartingXInternal(y + dy);
}
public double getEndingX(StringBounder stringBounder, double y) {
return getEndingXInternal(y + dy);
}
};
}
@Override
protected void drawHline(UGraphic ug, UHorizontalLine line, UTranslate translate) {
final UStroke stroke = UStroke.withThickness(1.5);
line.drawLineInternal(ug.apply(translate), getStencil2(translate), 0, stroke);
}
}
}