net.sourceforge.plantuml.sequencediagram.graphic.ParticipantBox Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-epl Show documentation
Show all versions of plantuml-epl 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 Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.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 EPL license.
*
* The generated images can then be used without any reference to the EPL 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.AbstractCollection;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
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.skin.Area;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.SimpleContext2D;
public class ParticipantBox implements Pushable {
private static int CPT = 0;
private final int outMargin;
private double startingX;
private final Component head;
private final Component line;
private final Component tail;
private final Component delayLine;
private int cpt = CPT++;
public ParticipantBox(Component head, Component line, Component tail, Component delayLine, double startingX,
int outMargin) {
this.outMargin = outMargin;
this.startingX = startingX;
this.head = head;
this.line = line;
this.tail = tail;
this.delayLine = delayLine;
}
@Override
public String toString() {
return "PB" + cpt;
}
public double getMinX() {
return startingX + outMargin;
}
public double getMaxX(StringBounder stringBounder) {
return startingX + head.getPreferredWidth(stringBounder) + 2 * outMargin;
}
public double getCenterX(StringBounder stringBounder) {
return startingX + head.getPreferredWidth(stringBounder) / 2.0 + outMargin;
}
public double getHeadHeight(StringBounder stringBounder) {
return head.getPreferredHeight(stringBounder) + line.getPreferredHeight(stringBounder) / 2.0;
}
public double getHeadHeightOnly(StringBounder stringBounder) {
return head.getPreferredHeight(stringBounder);
}
public double getPreferredWidth(StringBounder stringBounder) {
return head.getPreferredWidth(stringBounder);
}
public double getTailHeight(StringBounder stringBounder) {
return tail.getPreferredHeight(stringBounder) + line.getPreferredHeight(stringBounder) / 2.0;
}
public void pushToLeft(double deltaX) {
startingX += deltaX;
}
public void drawHeadTailU(UGraphic ug, double topStartingY, boolean showHead, double positionTail) {
if (topStartingY == 0) {
throw new IllegalStateException("setTopStartingY cannot be zero");
}
// final double atX = ug.getTranslateX();
// final double atY = ug.getTranslateY();
final StringBounder stringBounder = ug.getStringBounder();
if (showHead) {
final double y1 = topStartingY - head.getPreferredHeight(stringBounder)
- line.getPreferredHeight(stringBounder) / 2;
head.drawU(ug.apply(new UTranslate(getMinX(), y1)), new Area(
new XDimension2D(head.getPreferredWidth(stringBounder), head.getPreferredHeight(stringBounder))),
new SimpleContext2D(false));
// ug.setTranslate(atX, atY);
}
if (positionTail > 0) {
// final double y2 = positionTail - topStartingY +
// line.getPreferredHeight(stringBounder) / 2 - 1;
positionTail += line.getPreferredHeight(stringBounder) / 2 - 1;
// if (y2 != y22) {
// throw new IllegalStateException();
// }
ug = ug.apply(new UTranslate(getMinX(), positionTail));
tail.drawU(ug, new Area(
new XDimension2D(tail.getPreferredWidth(stringBounder), tail.getPreferredHeight(stringBounder))),
new SimpleContext2D(false));
// ug.setTranslate(atX, atY);
}
}
public void drawParticipantHead(UGraphic ug) {
// ug.translate(outMargin, 0);
final StringBounder stringBounder = ug.getStringBounder();
head.drawU(ug.apply(UTranslate.dx(outMargin)), new Area(
new XDimension2D(head.getPreferredWidth(stringBounder), head.getPreferredHeight(stringBounder))),
new SimpleContext2D(false));
// ug.translate(-outMargin, 0);
}
public void drawLineU22(UGraphic ug, double startingY, final double endingY, boolean showTail, double myDelta) {
ug = ug.apply(UTranslate.dx(startingX));
if (delays.size() > 0) {
final StringBounder stringBounder = ug.getStringBounder();
for (GraphicalDelayText delay : delays)
if (delay.getStartingY() - myDelta >= startingY) {
drawLineIfLowerThan(ug, startingY, delay.getStartingY() - myDelta, line, endingY);
drawLineIfLowerThan(ug, delay.getStartingY() - myDelta, delay.getEndingY(stringBounder) - myDelta,
delayLine, endingY);
startingY = delay.getEndingY(stringBounder) - myDelta;
}
if (delays.get(delays.size() - 1).getEndingY(stringBounder) - myDelta > startingY)
startingY = delays.get(delays.size() - 1).getEndingY(stringBounder) - myDelta;
}
drawLineIfLowerThan(ug, startingY, endingY, line, endingY);
}
private void drawLineIfLowerThan(UGraphic ug, double startingY, double endingY, Component comp, double limitY) {
startingY = Math.min(startingY, limitY);
endingY = Math.min(endingY, limitY);
if (startingY < limitY || endingY < limitY)
drawLine(ug, startingY, endingY, comp);
}
private void drawLine(UGraphic ug, double startingY, double endingY, Component comp) {
final StringBounder stringBounder = ug.getStringBounder();
comp.drawU(ug.apply(UTranslate.dy(startingY)),
new Area(new XDimension2D(head.getPreferredWidth(stringBounder) + outMargin * 2, endingY - startingY)),
new SimpleContext2D(false));
}
public double magicMargin(StringBounder stringBounder) {
return line.getPreferredHeight(stringBounder) / 2;
}
public double getStartingX() {
return startingX;
}
private final List delays = new ArrayList<>();
public void addDelay(GraphicalDelayText delay) {
this.delays.add(delay);
}
public Collection getDelays(final StringBounder stringBounder) {
return new AbstractCollection() {
@Override
public Iterator iterator() {
return new Iterator() {
private final Iterator it = delays.iterator();
public boolean hasNext() {
return it.hasNext();
}
public Segment next() {
final GraphicalDelayText d = it.next();
return new Segment(d.getStartingY(), d.getEndingY(stringBounder));
}
public void remove() {
throw new UnsupportedOperationException();
}
};
}
@Override
public int size() {
return delays.size();
}
};
}
}