net.sourceforge.plantuml.sequencediagram.graphic.LifeLine 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.sequencediagram.graphic;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import net.sourceforge.plantuml.klimt.Fashion;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.skin.ColorParam;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.ComponentType;
import net.sourceforge.plantuml.skin.SkinParamBackcolored;
import net.sourceforge.plantuml.skin.SkinParamForceColor;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.Style;
public class LifeLine {
static class Variation {
final private LifeSegmentVariation type;
final private Fashion colors;
final private double y;
Variation(LifeSegmentVariation type, double y, Fashion backcolor) {
this.type = type;
this.y = y;
this.colors = backcolor;
}
@Override
public String toString() {
return type + " " + y;
}
}
private final Pushable participant;
private final double nominalPreferredWidth;
private final List events = new ArrayList<>();
private final Stairs stairs = new Stairs();
private int maxLevel = 0;
private final boolean shadowing;
public LifeLine(Pushable participant, double nominalPreferredWidth, boolean shadowing) {
this.participant = participant;
this.nominalPreferredWidth = nominalPreferredWidth;
this.shadowing = shadowing;
}
public void addSegmentVariation(LifeSegmentVariation type, double y, Fashion colors) {
if (events.size() > 0) {
final Variation last = events.get(events.size() - 1);
if (y < last.y) {
return;
// throw new IllegalArgumentException();
}
if (y == last.y && type != last.type) {
return;
// throw new IllegalArgumentException();
}
}
events.add(new Variation(type, y, colors));
final int currentLevel = type.apply(stairs.getLastValue());
stairs.addStep(y, currentLevel);
assert getLevel(y) == stairs.getValue(y);
assert currentLevel == stairs.getValue(y);
assert getLevel(y) == currentLevel;
maxLevel = Math.max(getLevel(y), maxLevel);
}
public void finish(double y) {
final int missingClose = getMissingClose();
for (int i = 0; i < missingClose; i++) {
addSegmentVariation(LifeSegmentVariation.SMALLER, y, null);
}
}
int getMissingClose() {
int level = 0;
for (Variation ev : events) {
if (ev.type == LifeSegmentVariation.LARGER) {
level++;
} else {
level--;
}
}
return level;
}
int getLevel(double y) {
return stairs.getValue(y);
}
public int getMaxLevel() {
return maxLevel;
}
public double getRightShift(double y) {
return getRightShiftAtLevel(getLevel(y));
}
public double getLeftShift(double y) {
return getLeftShiftAtLevel(getLevel(y));
}
public double getMaxRightShift() {
return getRightShiftAtLevel(getMaxLevel());
}
public double getMaxLeftShift() {
return getLeftShiftAtLevel(getMaxLevel());
}
private double getRightShiftAtLevel(int level) {
if (level == 0) {
return 0;
}
return level * (nominalPreferredWidth / 2.0);
}
private double getLeftShiftAtLevel(int level) {
if (level == 0) {
return 0;
}
return nominalPreferredWidth / 2.0;
}
private double getStartingX(StringBounder stringBounder) {
final double delta = participant.getCenterX(stringBounder) - nominalPreferredWidth / 2.0;
return delta;
}
private SegmentColored getSegment(int i) {
if (events.get(i).type != LifeSegmentVariation.LARGER) {
return null;
}
int level = 1;
for (int j = i + 1; j < events.size(); j++) {
if (events.get(j).type == LifeSegmentVariation.LARGER) {
level++;
} else {
level--;
}
if (level == 0) {
final double y1 = events.get(i).y;
final double y2 = events.get(j).y;
return SegmentColored.create(y1, y2, events.get(i).colors, shadowing);
}
}
return SegmentColored.create(events.get(i).y, events.get(events.size() - 1).y, events.get(i).colors, shadowing);
}
private Collection getSegmentsCutted(StringBounder stringBounder, int i) {
final SegmentColored seg = getSegment(i);
if (seg != null) {
return seg.cutSegmentIfNeed(participant.getDelays(stringBounder));
}
return Collections.emptyList();
}
public void drawU(UGraphic ug, Rose skin, ISkinParam skinParam) {
final StringBounder stringBounder = ug.getStringBounder();
ug = ug.apply(UTranslate.dx(getStartingX(stringBounder)));
int eventLevel = 0;
for (int i = 0; i < events.size(); i++) {
ComponentType type = ComponentType.ALIVE_BOX_CLOSE_OPEN;
Collection segmentsCutted = getSegmentsCutted(stringBounder, i);
if (events.get(i).type == LifeSegmentVariation.LARGER)
eventLevel++;
else if (events.get(i).type == LifeSegmentVariation.SMALLER)
eventLevel = Math.max(0,eventLevel-1);
for (final Iterator it = segmentsCutted.iterator(); it.hasNext();) {
final SegmentColored seg = it.next();
final HColor specificBackColor = seg.getSpecificBackColor();
ISkinParam skinParam2 = new SkinParamBackcolored(skinParam, specificBackColor);
final HColor specificLineColor = seg.getSpecificLineColor();
if (specificLineColor != null) {
skinParam2 = new SkinParamForceColor(skinParam2, ColorParam.sequenceLifeLineBorder,
specificLineColor);
}
if (it.hasNext() == false) {
type = type == ComponentType.ALIVE_BOX_CLOSE_OPEN ? ComponentType.ALIVE_BOX_CLOSE_CLOSE
: ComponentType.ALIVE_BOX_OPEN_CLOSE;
}
Style style = type.getStyleSignature().getMergedStyle(skinParam2.getCurrentStyleBuilder());
if (style != null) {
style = style.eventuallyOverride(PName.BackGroundColor, specificBackColor);
style = style.eventuallyOverride(PName.LineColor, specificLineColor);
}
final Component compAliveBox = skin.createComponent(new Style[] { style }, type, null, skinParam2,
null);
type = ComponentType.ALIVE_BOX_OPEN_OPEN;
final int currentLevel = Math.min(eventLevel,getLevel(seg.getPos1Initial()));
seg.drawU(ug, compAliveBox, currentLevel);
}
}
}
private double create = 0;
// private double destroy = 0;
public final void setCreate(double create) {
this.create = create;
}
public final double getCreate() {
return create;
}
public final double getDestroy() {
return 0;
}
// public final void setDestroy(double destroy) {
// this.destroy = destroy;
// }
public final boolean shadowing() {
return shadowing;
}
public Fashion getColors() {
if (events.size() == 0) {
return null;
}
return events.get(events.size() - 1).colors;
}
}