net.sourceforge.plantuml.sequencediagram.teoz.CommunicationExoTile Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.sequencediagram.teoz;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.real.Real;
import net.sourceforge.plantuml.sequencediagram.Event;
import net.sourceforge.plantuml.sequencediagram.MessageExo;
import net.sourceforge.plantuml.sequencediagram.MessageExoType;
import net.sourceforge.plantuml.skin.Area;
import net.sourceforge.plantuml.skin.ArrowComponent;
import net.sourceforge.plantuml.skin.ArrowConfiguration;
import net.sourceforge.plantuml.skin.ArrowDecoration;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.Context2D;
import net.sourceforge.plantuml.skin.rose.ComponentRoseArrow;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.style.ISkinParam;
public class CommunicationExoTile extends AbstractTile {
private final LivingSpace livingSpace;
private final MessageExo message;
private final Rose skin;
private final ISkinParam skinParam;
private final TileArguments tileArguments;
private final YGauge yGauge;
public Event getEvent() {
return message;
}
public CommunicationExoTile(LivingSpace livingSpace, MessageExo message, Rose skin, ISkinParam skinParam,
TileArguments tileArguments, YGauge currentY) {
super(tileArguments.getStringBounder(), currentY);
this.tileArguments = tileArguments;
this.livingSpace = livingSpace;
this.message = message;
this.skin = skin;
this.skinParam = skinParam;
this.yGauge = YGauge.create(currentY.getMax(), getPreferredHeight());
}
@Override
public YGauge getYGauge() {
return yGauge;
}
@Override
public double getContactPointRelative() {
return getComponent(getStringBounder()).getYPoint(getStringBounder());
}
private ArrowComponent getComponent(StringBounder stringBounder) {
ArrowConfiguration arrowConfiguration = message.getArrowConfiguration();
if (message.getType().getDirection() == -1)
arrowConfiguration = arrowConfiguration.reverse();
final ArrowComponent comp = skin.createComponentArrow(message.getUsedStyles(), arrowConfiguration, skinParam,
message.getLabelNumbered());
return comp;
}
public void drawU(UGraphic ug) {
if (YGauge.USE_ME)
ug = ug.apply(UTranslate.dy(getYGauge().getMin().getCurrentValue()));
final StringBounder stringBounder = ug.getStringBounder();
final Component comp = getComponent(stringBounder);
final XDimension2D dim = comp.getPreferredDimension(stringBounder);
double x1 = getPoint1Value(stringBounder);
double x2 = getPoint2Value(stringBounder);
final double textDeltaX = isFromLeftBorderMessage()
? getPoint1(stringBounder).getCurrentValue() - x1
: isFromRightBorderMessage()
? getPoint2(stringBounder).getCurrentValue() - x2
: 0;
final int level = livingSpace.getLevelAt(this, EventsHistoryMode.IGNORE_FUTURE_DEACTIVATE);
if (level > 0) {
if (message.getType().isRightBorder())
x1 += CommunicationTile.LIVE_DELTA_SIZE * level;
else
x2 += CommunicationTile.LIVE_DELTA_SIZE * (level - 2);
}
final ArrowConfiguration arrowConfiguration = message.getArrowConfiguration();
final MessageExoType type = message.getType();
if (arrowConfiguration.getDecoration1() == ArrowDecoration.CIRCLE && type == MessageExoType.FROM_LEFT)
x1 += ComponentRoseArrow.diamCircle / 2 + 2;
if (arrowConfiguration.getDecoration2() == ArrowDecoration.CIRCLE && type == MessageExoType.TO_LEFT)
x1 += ComponentRoseArrow.diamCircle / 2 + 2;
if (arrowConfiguration.getDecoration2() == ArrowDecoration.CIRCLE && type == MessageExoType.TO_RIGHT)
x2 -= ComponentRoseArrow.diamCircle / 2 + 2;
if (arrowConfiguration.getDecoration1() == ArrowDecoration.CIRCLE && type == MessageExoType.FROM_RIGHT)
x2 -= ComponentRoseArrow.diamCircle / 2 + 2;
final Area area = Area.create(x2 - x1, dim.getHeight());
area.setTextDeltaX(textDeltaX);
ug = ug.apply(UTranslate.dx(x1));
comp.drawU(ug, area, (Context2D) ug);
}
private boolean isShortArrow() {
return message.isShortArrow();
}
@Override
public double getPreferredHeight() {
final Component comp = getComponent(getStringBounder());
final XDimension2D dim = comp.getPreferredDimension(getStringBounder());
return dim.getHeight();
}
private double getPreferredWidth(StringBounder stringBounder) {
final Component comp = getComponent(stringBounder);
final XDimension2D dim = comp.getPreferredDimension(stringBounder);
return dim.getWidth();
}
public void addConstraints() {
final Component comp = getComponent(getStringBounder());
final XDimension2D dim = comp.getPreferredDimension(getStringBounder());
final double width = dim.getWidth();
if (message.getType().isRightBorder()) {
} else {
livingSpace.getPosC(getStringBounder()).ensureBiggerThan(tileArguments.getXOrigin().addFixed(width));
}
// final Real point1 = getPoint1(stringBounder);
// if (message.getType().isRightBorder()) {
// final Real point2 = point1.addFixed(width);
// } else {
// final Real point2 = getPoint2(stringBounder);
// if (point1.getCurrentValue() < point2.getCurrentValue()) {
// point2.ensureBiggerThan(point1.addFixed(width));
// } else {
// point1.ensureBiggerThan(point2.addFixed(width));
// }
// }
}
@Override
final protected void callbackY_internal(TimeHook y) {
super.callbackY_internal(y);
final ArrowComponent comp = getComponent(getStringBounder());
final XDimension2D dim = comp.getPreferredDimension(getStringBounder());
final double arrowY = comp.getStartPoint(getStringBounder(), dim).getY();
livingSpace.addStepForLivebox(getEvent(), y.getValue() + arrowY);
}
private Real getPoint1(final StringBounder stringBounder) {
if (message.getType().isRightBorder())
return livingSpace.getPosC(stringBounder);
return livingSpace.getPosC(stringBounder).addFixed(-getPreferredWidth(stringBounder));
}
private Real getPoint2(final StringBounder stringBounder) {
if (message.getType().isLeftBorder())
return livingSpace.getPosC(stringBounder);
return getPoint1(stringBounder).addFixed(getPreferredWidth(stringBounder));
}
private double getPoint1Value(final StringBounder stringBounder) {
if (isFromLeftBorderMessage())
return tileArguments.getBorder1();
return getPoint1(stringBounder).getCurrentValue();
}
private double getPoint2Value(final StringBounder stringBounder) {
if (isFromRightBorderMessage())
return tileArguments.getBorder2();
return getPoint2(stringBounder).getCurrentValue();
}
public Real getMinX() {
return getPoint1(getStringBounder());
}
public Real getMaxX() {
return getPoint2(getStringBounder());
}
final public double getMiddleX() {
if (!isFromLeftBorderMessage())
return super.getMiddleX();
final double min = getPoint1Value(getStringBounder());
final double max = isFromLeftBorderMessage()
? min + getPreferredWidth(getStringBounder())
: getPoint2Value(getStringBounder());
return (min + max) / 2;
}
public boolean isFromRightBorderMessage() {
return message.getType().isRightBorder() && !isShortArrow();
}
public boolean isFromLeftBorderMessage() {
return message.getType().isLeftBorder() && !isShortArrow();
}
}