/* ======================================================================== * PlantUML : a free UML diagram generator * ======================================================================== * * (C) Copyright 2009-2023, Arnaud Roques * * Project Info: http://plantuml.com * * If you like this project or if you find it useful, you can support us at: * * http://plantuml.com/patreon (only 1$ per month!) * http://plantuml.com/paypal * * This file is part of PlantUML. * * PlantUML is free software; you can redistribute it and/or modify it * under the terms of the GNU 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 General Public * License for more details. * * You should have received a copy of the GNU General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, * USA. * * * Original Author: Arnaud Roques * */ package net.sourceforge.plantuml.timingdiagram; import java.math.BigDecimal; import net.sourceforge.plantuml.ISkinParam; import net.sourceforge.plantuml.awt.geom.Dimension2D; import net.sourceforge.plantuml.command.Position; import net.sourceforge.plantuml.cucadiagram.Display; import net.sourceforge.plantuml.graphic.AbstractTextBlock; import net.sourceforge.plantuml.graphic.StringBounder; import net.sourceforge.plantuml.graphic.TextBlock; import net.sourceforge.plantuml.graphic.TextBlockUtils; import net.sourceforge.plantuml.graphic.UDrawable; import net.sourceforge.plantuml.graphic.color.Colors; 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.ugraphic.UGraphic; import net.sourceforge.plantuml.ugraphic.ULine; import net.sourceforge.plantuml.ugraphic.UTranslate; 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; } 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; } protected StyleSignatureBasic getStyleSignature() { return StyleSignatureBasic.of(SName.root, SName.element, SName.timingDiagram, SName.clock); } public IntricatedPoint getTimeProjection(StringBounder stringBounder, TimeTick tick) { throw new UnsupportedOperationException(); } public void addNote(TimeTick now, Display note, Position position) { throw new UnsupportedOperationException(); } public void defineState(String stateCode, String label) { throw new UnsupportedOperationException(); } public void setState(TimeTick now, String comment, Colors color, String... states) { throw new UnsupportedOperationException(); } public void createConstraint(TimeTick tick1, TimeTick tick2, String message) { throw new UnsupportedOperationException(); } public final int getPeriod() { return period; } public TextBlock getPart1(double fullAvailableWidth, double specialVSpace) { if (displayTitle) return new AbstractTextBlock() { public void drawU(UGraphic ug) { new PlayerFrame(getTitle(), skinParam).drawFrameTitle(ug); } public Dimension2D calculateDimension(StringBounder stringBounder) { return getTitle().calculateDimension(stringBounder); } }; return TextBlockUtils.empty(0, 0); } 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); } } }; } }