net.sourceforge.plantuml.timingdiagram.PlayerClock 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.math.BigDecimal;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.Colors;
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.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.UDrawable;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.skin.ArrowConfiguration;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.timingdiagram.graphic.IntricatedPoint;
import net.sourceforge.plantuml.timingdiagram.graphic.PlayerFrame;
import net.sourceforge.plantuml.utils.Position;
public class PlayerClock extends Player {
private final int period;
private final int pulse;
private final int offset;
private final double ymargin = 8;
private final boolean displayTitle;
public PlayerClock(String title, ISkinParam skinParam, TimingRuler ruler, int period, int pulse, int offset,
boolean compact) {
super(title, skinParam, ruler, compact, null);
this.displayTitle = title.length() > 0;
this.period = period;
this.pulse = pulse;
this.offset = offset;
this.suggestedHeight = 30;
}
@Override
public double getFullHeight(StringBounder stringBounder) {
return suggestedHeight + getTitleHeight(stringBounder);
}
private double getLineHeight(StringBounder stringBounder) {
return suggestedHeight - 2 * ymargin;
}
private double getTitleHeight(StringBounder stringBounder) {
if (displayTitle)
return getTitle().calculateDimension(stringBounder).getHeight();
return 0;
}
@Override
protected StyleSignatureBasic getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.clock);
}
@Override
public IntricatedPoint getTimeProjection(StringBounder stringBounder, TimeTick tick) {
throw new UnsupportedOperationException();
}
@Override
public void addNote(TimeTick now, Display note, Position position) {
throw new UnsupportedOperationException();
}
@Override
public void defineState(String stateCode, String label) {
throw new UnsupportedOperationException();
}
@Override
public void setState(TimeTick now, String comment, Colors color, String... states) {
throw new UnsupportedOperationException();
}
@Override
public void createConstraint(TimeTick tick1, TimeTick tick2, String message, ArrowConfiguration config) {
throw new UnsupportedOperationException();
}
public final int getPeriod() {
return period;
}
@Override
public TextBlock getPart1(double fullAvailableWidth, double specialVSpace) {
if (displayTitle)
return new AbstractTextBlock() {
public void drawU(UGraphic ug) {
new PlayerFrame(getTitle(), skinParam).drawFrameTitle(ug);
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return getTitle().calculateDimension(stringBounder);
}
};
return TextBlockUtils.empty(0, 0);
}
@Override
public UDrawable getPart2() {
return new UDrawable() {
private void drawHline(UGraphic ug, double value1, double value2) {
final double x1 = getX(value1);
final double x2 = Math.min(ruler.getWidth(), getX(value2));
final ULine hline = ULine.hline(x2 - x1);
ug.apply(UTranslate.dx(x1)).draw(hline);
}
private void drawVline(UGraphic ug, final ULine vline, double value) {
ug.apply(new UTranslate(getX(value), ymargin)).draw(vline);
}
private double getX(double value) {
return ruler.getPosInPixel(new TimeTick(new BigDecimal(value), TimingFormat.DECIMAL));
}
public void drawU(UGraphic ug) {
ug = getContext().apply(ug);
ug = ug.apply(UTranslate.dy(getTitleHeight(ug.getStringBounder())));
final ULine vline = ULine.vline(getLineHeight(ug.getStringBounder()));
double value = 0;
if (offset != 0) {
drawHline(ug.apply(UTranslate.dy(ymargin + vline.getDY())), value, offset);
value += offset;
}
if (getX(value) > ruler.getWidth())
return;
drawVline(ug, vline, value);
final double vpulse = pulse == 0 ? period / 2.0 : pulse;
final double remain = period - vpulse;
for (int i = 0; i < 1000; i++) {
drawHline(ug.apply(UTranslate.dy(ymargin)), value, value + vpulse);
value += vpulse;
if (getX(value) > ruler.getWidth())
return;
drawVline(ug, vline, value);
drawHline(ug.apply(UTranslate.dy(ymargin + vline.getDY())), value, value + remain);
value += remain;
if (getX(value) > ruler.getWidth())
return;
drawVline(ug, vline, value);
}
}
};
}
}