net.sourceforge.plantuml.sequencediagram.graphic.MessageArrow 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.sequencediagram.graphic;
import java.util.Objects;
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.sequencediagram.NotePosition;
import net.sourceforge.plantuml.skin.Area;
import net.sourceforge.plantuml.skin.ArrowComponent;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.Context2D;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.url.Url;
class MessageArrow extends Arrow {
private final LivingParticipantBox p1;
private final LivingParticipantBox p2;
private final Component compAliveBox;
public MessageArrow(double startingY, Rose skin, ArrowComponent arrow, LivingParticipantBox p1,
LivingParticipantBox p2, Url url, Component compAliveBox) {
super(startingY, skin, arrow, url);
if (p1 == p2) {
throw new IllegalArgumentException();
}
this.p1 = Objects.requireNonNull(p1);
this.p2 = Objects.requireNonNull(p2);
this.compAliveBox = compAliveBox;
}
@Override
public double getActualWidth(StringBounder stringBounder) {
final double r = getRightEndInternal(stringBounder) - getLeftStartInternal(stringBounder);
assert r > 0;
return r;
}
private double getLeftStartInternal(StringBounder stringBounder) {
return getParticipantAt(stringBounder, NotePosition.LEFT)
.getLiveThicknessAt(stringBounder, getArrowYStartLevel(stringBounder)).getSegment().getPos2();
}
private double getRightEndInternal(StringBounder stringBounder) {
final Segment segment = getParticipantAt(stringBounder, NotePosition.RIGHT)
.getLiveThicknessAt(stringBounder, getArrowYStartLevel(stringBounder)).getSegment();
if (segment.getLength() == 0) {
return segment.getPos1();
}
final double rectWidth = compAliveBox.getPreferredWidth(stringBounder);
return segment.getPos2() - rectWidth;
}
@Override
public double getPreferredHeight(StringBounder stringBounder) {
return getArrowComponent().getPreferredHeight(stringBounder);
}
@Override
public double getStartingX(StringBounder stringBounder) {
return getLeftStartInternal(stringBounder);
}
@Override
public int getDirection(StringBounder stringBounder) {
final double x1 = p1.getParticipantBox().getCenterX(stringBounder);
final double x2 = p2.getParticipantBox().getCenterX(stringBounder);
if (x1 < x2) {
return 1;
}
return -1;
}
public LivingParticipantBox getParticipantAt(StringBounder stringBounder, NotePosition position) {
final int direction = getDirection(stringBounder);
if (direction == 1 && position == NotePosition.RIGHT) {
return p2;
}
if (direction == 1 && position == NotePosition.LEFT) {
return p1;
}
if (direction == -1 && position == NotePosition.RIGHT) {
return p1;
}
if (direction == -1 && position == NotePosition.LEFT) {
return p2;
}
throw new IllegalArgumentException();
}
@Override
public double getPreferredWidth(StringBounder stringBounder) {
return getArrowComponent().getPreferredWidth(stringBounder);
}
@Override
protected void drawInternalU(UGraphic ug, double maxX, Context2D context) {
final StringBounder stringBounder = ug.getStringBounder();
ug = ug.apply(new UTranslate(getStartingX(stringBounder), getStartingY()));
startUrl(ug);
getArrowComponent().drawU(ug, new Area(getActualDimension(stringBounder)), context);
endUrl(ug);
}
private XDimension2D getActualDimension(StringBounder stringBounder) {
return new XDimension2D(getActualWidth(stringBounder) - getPaddingArrowHead(),
getArrowComponent().getPreferredHeight(stringBounder));
}
@Override
public double getArrowYStartLevel(StringBounder stringBounder) {
if (getArrowComponent() instanceof ArrowComponent) {
final ArrowComponent arrowComponent = (ArrowComponent) getArrowComponent();
final XDimension2D dim = new XDimension2D(arrowComponent.getPreferredWidth(stringBounder),
arrowComponent.getPreferredHeight(stringBounder));
return getStartingY() + arrowComponent.getStartPoint(stringBounder, dim).getY();
}
return getStartingY();
}
@Override
public double getArrowYEndLevel(StringBounder stringBounder) {
if (getArrowComponent() instanceof ArrowComponent) {
final ArrowComponent arrowComponent = (ArrowComponent) getArrowComponent();
final XDimension2D dim = new XDimension2D(arrowComponent.getPreferredWidth(stringBounder),
arrowComponent.getPreferredHeight(stringBounder));
return getStartingY() + arrowComponent.getEndPoint(stringBounder, dim).getY();
}
return getStartingY() + getArrowComponent().getPreferredHeight(stringBounder);
}
public double getMaxX(StringBounder stringBounder) {
return getRightEndInternal(stringBounder);
}
public double getMinX(StringBounder stringBounder) {
return getLeftStartInternal(stringBounder);
}
public String toString(StringBounder stringBounder) {
return getMinX(stringBounder) + "-" + getMaxX(stringBounder);
}
}