net.sourceforge.plantuml.timingdiagram.TimingRuler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-lgpl Show documentation
Show all versions of plantuml-lgpl 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 Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see times = new TreeSet<>();
private final ISkinParam skinParam;
private long tickIntervalInPixels = 50;
private long tickUnitary;
private TimingFormat format = TimingFormat.DECIMAL;
static UGraphic applyForVLines(UGraphic ug, Style style, ISkinParam skinParam) {
final UStroke stroke = new UStroke(3, 5, 0.5);
final HColor color = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
return ug.apply(stroke).apply(color);
}
public void ensureNotEmpty() {
if (times.size() == 0)
this.times.add(new TimeTick(BigDecimal.ZERO, TimingFormat.DECIMAL));
if (getMax().getTime().signum() > 0 && getMin().getTime().signum() < 0)
this.times.add(new TimeTick(BigDecimal.ZERO, TimingFormat.DECIMAL));
}
public TimingRuler(ISkinParam skinParam) {
this.skinParam = skinParam;
}
public void scaleInPixels(long tick, long pixel) {
if (pixel <= 0 || tick <= 0)
throw new IllegalArgumentException();
this.tickIntervalInPixels = pixel;
this.tickUnitary = tick;
}
private long tickUnitary() {
if (tickUnitary == 0)
return highestCommonFactor();
return tickUnitary;
}
private long highestCommonFactorInternal = -1;
private long highestCommonFactor() {
if (highestCommonFactorInternal == -1) {
for (long tick : getAbsolutesTicks()) {
if (highestCommonFactorInternal == -1) {
highestCommonFactorInternal = tick;
} else {
final long candidate = computeHighestCommonFactor(highestCommonFactorInternal, tick);
final double size = (getMax().getTime().doubleValue() - getMin().getTime().doubleValue())
/ candidate;
if (size > 200)
return highestCommonFactorInternal;
highestCommonFactorInternal = candidate;
}
}
}
return highestCommonFactorInternal;
}
private Set getAbsolutesTicks() {
final Set result = new TreeSet<>(new Comparator() {
public int compare(Long o1, Long o2) {
return o2.compareTo(o1);
}
});
for (TimeTick time : times) {
final long value = Math.abs(time.getTime().longValue());
if (value > 0)
result.add(value);
}
return result;
}
private int getNbTick() {
if (times.size() == 0)
return 1;
final long delta = getMax().getTime().longValue() - getMin().getTime().longValue();
return Math.min(1000, (int) (1 + delta / tickUnitary()));
}
public double getWidth() {
if (times.size() == 0)
return 100;
final double delta = getMax().getTime().doubleValue() - getMin().getTime().doubleValue();
return (delta / tickUnitary() + 1) * tickIntervalInPixels;
}
public final double getPosInPixel(TimeTick when) {
return getPosInPixelInternal(when.getTime().doubleValue());
}
private double getPosInPixelInternal(double time) {
time -= getMin().getTime().doubleValue();
return time / tickUnitary() * tickIntervalInPixels;
}
private long tickToTime(int i) {
return tickUnitary * i + getMin().getTime().longValue();
}
public void addTime(TimeTick time) {
this.highestCommonFactorInternal = -1;
times.add(time);
if (time.getFormat() != TimingFormat.DECIMAL)
this.format = time.getFormat();
}
private Style getStyleTimegrid() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.timegrid)
.getMergedStyle(skinParam.getCurrentStyleBuilder());
}
private Style getStyleTimeline() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.timeline)
.getMergedStyle(skinParam.getCurrentStyleBuilder());
}
private TextBlock getTimeTextBlock(long time) {
return getTimeTextBlock(format.formatTime(time));
}
private TextBlock getTimeTextBlock(String string) {
final Display display = Display.getWithNewlines(string);
final FontConfiguration fontConfiguration = FontConfiguration.create(skinParam, getStyleTimeline());
return display.create(fontConfiguration, HorizontalAlignment.LEFT, skinParam);
}
public void drawTimeAxis(UGraphic ug, TimeAxisStategy timeAxisStategy, Map codes) {
if (timeAxisStategy == TimeAxisStategy.HIDDEN)
return;
final Style styleTimeline = getStyleTimeline();
final Style styleTimegrid = getStyleTimegrid();
final HColor color = styleTimeline.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
final UStroke stroke = styleTimeline.getStroke();
ug = ug.apply(stroke).apply(color);
if (timeAxisStategy == TimeAxisStategy.AUTOMATIC)
drawTimeAxisAutomatic(ug);
else
drawTimeAxisManual(ug, codes);
}
private void drawTimeAxisManual(UGraphic ug, Map codes) {
final double tickHeight = 5;
final ULine line = ULine.vline(tickHeight);
final double firstTickPosition = getPosInPixelInternal(getFirstPositiveOrZeroValue().doubleValue());
int nb = 0;
while (firstTickPosition + nb * tickIntervalInPixels <= getWidth())
nb++;
ug.apply(UTranslate.dx(firstTickPosition)).draw(ULine.hline((nb - 1) * tickIntervalInPixels));
for (TimeTick tick : times) {
ug.apply(UTranslate.dx(getPosInPixel(tick))).draw(line);
final String label = getLabel(tick, codes);
if (label.length() == 0)
continue;
final TextBlock text = getTimeTextBlock(label);
final XDimension2D dim = text.calculateDimension(ug.getStringBounder());
text.drawU(ug.apply(new UTranslate(getPosInPixel(tick) - dim.getWidth() / 2, tickHeight + 1)));
}
}
private void drawTimeAxisAutomatic(UGraphic ug) {
final double tickHeight = 5;
final ULine line = ULine.vline(tickHeight);
final double firstTickPosition = getPosInPixelInternal(getFirstPositiveOrZeroValue().doubleValue());
int nb = 0;
while (firstTickPosition + nb * tickIntervalInPixels <= getWidth()) {
ug.apply(UTranslate.dx(firstTickPosition + nb * tickIntervalInPixels)).draw(line);
nb++;
}
ug.apply(UTranslate.dx(firstTickPosition)).draw(ULine.hline((nb - 1) * tickIntervalInPixels));
for (long round : roundValues()) {
final TextBlock text = getTimeTextBlock(round);
final XDimension2D dim = text.calculateDimension(ug.getStringBounder());
text.drawU(ug.apply(new UTranslate(getPosInPixelInternal(round) - dim.getWidth() / 2, tickHeight + 1)));
}
}
private String getLabel(TimeTick tick, Map codes) {
for (Entry ent : codes.entrySet())
if (tick.equals(ent.getValue()))
return ent.getKey();
return format.formatTime(tick.getTime());
}
private BigDecimal getFirstPositiveOrZeroValue() {
for (TimeTick time : times)
if (time.getTime().signum() >= 0)
return time.getTime();
throw new IllegalStateException();
}
private Collection roundValues() {
final SortedSet result = new TreeSet<>();
if (tickUnitary == 0) {
for (TimeTick tick : times) {
final long round = tick.getTime().longValue();
result.add(round);
}
} else {
final int nb = getNbTick();
for (int i = 0; i <= nb; i++) {
final long round = tickToTime(i);
result.add(round);
}
}
if (result.first() < 0 && result.last() > 0)
result.add(0L);
return result;
}
public void drawVlines(UGraphic ug, double height) {
ug = applyForVLines(ug, getStyleTimegrid(), skinParam);
final ULine line = ULine.vline(height);
final int nb = getNbTick();
for (int i = 0; i <= nb; i++)
ug.apply(UTranslate.dx(tickIntervalInPixels * i)).draw(line);
}
public double getHeight(StringBounder stringBounder) {
return getTimeTextBlock(0).calculateDimension(stringBounder).getHeight();
}
private TimeTick getMax() {
return times.last();
}
private TimeTick getMin() {
return times.first();
}
private static long computeHighestCommonFactor(long a, long b) {
long r = a;
while (r != 0) {
r = a % b;
a = b;
b = r;
}
return (Math.abs(a));
}
}