net.sourceforge.plantuml.timingdiagram.PlayerRobustConcise 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.timingdiagram;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import net.sourceforge.plantuml.klimt.UTranslate;
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.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UDrawable;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.skin.ArrowConfiguration;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ISkinParam;
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.timingdiagram.graphic.Histogram;
import net.sourceforge.plantuml.timingdiagram.graphic.IntricatedPoint;
import net.sourceforge.plantuml.timingdiagram.graphic.PDrawing;
import net.sourceforge.plantuml.timingdiagram.graphic.PlayerFrame;
import net.sourceforge.plantuml.timingdiagram.graphic.Ribbon;
import net.sourceforge.plantuml.utils.Position;
public final class PlayerRobustConcise extends Player {
private final Set changes = new TreeSet<>();
private final List constraints = new ArrayList<>();
private final List notes = new ArrayList<>();
private final Map statesLabel = new LinkedHashMap();
private final TimingStyle type;
private String initialState;
private PDrawing cached;
private Colors initialColors;
public PlayerRobustConcise(TimingStyle type, String full, ISkinParam skinParam, TimingRuler ruler, boolean compact,
Stereotype stereotype, HColor generalBackgroundColor) {
super(full, skinParam, ruler, compact, stereotype, generalBackgroundColor);
this.type = type;
this.suggestedHeight = 0;
}
@Override
public final void createConstraint(TimeTick tick1, TimeTick tick2, String message, ArrowConfiguration config) {
final double margin = type == TimingStyle.ROBUST ? 2.5 : 1;
this.constraints.add(new TimeConstraint(margin, tick1, tick2, message, skinParam, config));
}
@Override
protected StyleSignature getStyleSignature() {
if (type == TimingStyle.CONCISE)
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.concise)
.withTOBECHANGED(stereotype);
if (type == TimingStyle.ROBUST)
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.robust)
.withTOBECHANGED(stereotype);
throw new IllegalStateException();
}
private PDrawing buildPDrawing() {
final Style style = getStyleSignature().getMergedStyle(skinParam.getCurrentStyleBuilder());
if (type == TimingStyle.CONCISE)
return new Ribbon(ruler, skinParam, notes, isCompact(), getTitle(), suggestedHeight, style);
if (type == TimingStyle.ROBUST) {
final Style style0 = StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram)
.getMergedStyle(skinParam.getCurrentStyleBuilder());
return new Histogram(ruler, skinParam, statesLabel.values(), isCompact(), getTitle(), suggestedHeight,
style, style0);
}
throw new IllegalStateException();
}
@Override
public final TextBlock getPart1(final double fullAvailableWidth, final double specialVSpace) {
return new AbstractTextBlock() {
public void drawU(UGraphic ug) {
if (isCompact() == false)
new PlayerFrame(getTitle(), skinParam).drawFrameTitle(ug);
ug = ug.apply(getTranslateForTimeDrawing(ug.getStringBounder())).apply(UTranslate.dy(specialVSpace));
getTimeDrawing().getPart1(fullAvailableWidth).drawU(ug);
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return getTimeDrawing().getPart1(fullAvailableWidth).calculateDimension(stringBounder);
}
};
}
@Override
public UDrawable getPart2() {
return new UDrawable() {
public void drawU(UGraphic ug) {
ug = ug.apply(getTranslateForTimeDrawing(ug.getStringBounder()));
getTimeDrawing().getPart2().drawU(ug);
}
};
}
private UTranslate getTranslateForTimeDrawing(StringBounder stringBounder) {
return UTranslate.dy(getTitleHeight(stringBounder));
}
@Override
public final double getFullHeight(StringBounder stringBounder) {
return getTitleHeight(stringBounder) + getZoneHeight(stringBounder);
}
private double getTitleHeight(StringBounder stringBounder) {
if (isCompact())
return 6;
return getTitle().calculateDimension(stringBounder).getHeight() + 6;
}
private PDrawing getTimeDrawing() {
if (cached == null)
cached = computeTimeDrawing();
return cached;
}
private PDrawing computeTimeDrawing() {
final PDrawing result = buildPDrawing();
result.setInitialState(initialState, initialColors);
for (ChangeState change : changes)
result.addChange(change);
for (TimeConstraint constraint : constraints)
result.addConstraint(constraint);
return result;
}
private double getZoneHeight(StringBounder stringBounder) {
return getTimeDrawing().getFullHeight(stringBounder);
}
@Override
public final void setState(TimeTick now, String comment, Colors color, String... states) {
for (int i = 0; i < states.length; i++)
states[i] = decodeState(states[i]);
if (now == null) {
this.initialState = states[0];
this.initialColors = color;
} else {
this.changes.add(new ChangeState(now, comment, color, states));
}
}
private String decodeState(String code) {
final String label = statesLabel.get(code);
if (label == null)
return code;
return label;
}
@Override
public final IntricatedPoint getTimeProjection(StringBounder stringBounder, TimeTick tick) {
if (tick == null)
return null;
final IntricatedPoint point = getTimeDrawing().getTimeProjection(stringBounder, tick);
if (point == null)
return null;
final UTranslate translation = getTranslateForTimeDrawing(stringBounder);
return point.translated(translation);
}
@Override
public final void addNote(TimeTick now, Display note, Position position) {
final StyleSignatureBasic signature = StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram,
SName.note);
final Style style = signature.getMergedStyle(skinParam.getCurrentStyleBuilder());
this.notes.add(new TimingNote(now, this, note, position, skinParam, style));
}
@Override
public final void defineState(String stateCode, String label) {
statesLabel.put(stateCode, label);
}
}