net.sourceforge.plantuml.project.draw.TaskDrawDiamond Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.project.draw;
import net.sourceforge.plantuml.klimt.UShape;
import net.sourceforge.plantuml.klimt.UTranslate;
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.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.klimt.sprite.SpriteContainerEmpty;
import net.sourceforge.plantuml.project.LabelStrategy;
import net.sourceforge.plantuml.project.ToTaskDraw;
import net.sourceforge.plantuml.project.core.Task;
import net.sourceforge.plantuml.project.core.TaskAttribute;
import net.sourceforge.plantuml.project.lang.CenterBorderColor;
import net.sourceforge.plantuml.project.time.Day;
import net.sourceforge.plantuml.project.timescale.TimeScale;
import net.sourceforge.plantuml.real.Real;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignature;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
public class TaskDrawDiamond extends AbstractTaskDraw {
public TaskDrawDiamond(TimeScale timeScale, Real y, String prettyDisplay, Day start, Task task,
ToTaskDraw toTaskDraw, StyleBuilder styleBuilder) {
super(timeScale, y, prettyDisplay, start, task, toTaskDraw, styleBuilder);
}
@Override
StyleSignature getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.milestone);
}
@Override
public double getHeightMax(StringBounder stringBounder) {
return getFullHeightTask(stringBounder);
}
@Override
protected double getShapeHeight(StringBounder stringBounder) {
final TextBlock title = getTitle();
final XDimension2D titleDim = title.calculateDimension(stringBounder);
return Math.max(titleDim.getHeight(), getDiamondHeight());
}
private double getDiamondHeight() {
int result = (int) getFontConfiguration().getFont().getSize2D();
if (result % 2 == 1)
result--;
return result;
}
@Override
final public void drawTitle(UGraphic ug, LabelStrategy labelStrategy, double colTitles, double colBars) {
final Style style = getStyle();
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final ClockwiseTopRightBottomLeft padding = style.getPadding();
final TextBlock title = getTitle();
ug = ug.apply(UTranslate.dy(margin.getTop()));
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D titleDim = title.calculateDimension(stringBounder);
final double h = (getShapeHeight(stringBounder) - titleDim.getHeight()) / 2;
final double x;
if (labelStrategy.titleInFirstColumn()) {
if (labelStrategy.rightAligned())
x = colTitles - titleDim.getWidth() - margin.getRight();
else
x = margin.getLeft();
} else if (labelStrategy.titleInLastColumn()) {
x = colBars + margin.getLeft();
} else {
final double x1 = timeScale.getStartingPosition(start);
final double x2 = timeScale.getEndingPosition(start);
final double width = getDiamondHeight();
final double delta = x2 - x1 - width;
x = x2 - delta / 2 + padding.getLeft();
}
title.drawU(ug.apply(new UTranslate(x, h)));
}
@Override
protected TextBlock getTitle() {
return Display.getWithNewlines(prettyDisplay).create(getFontConfiguration(), HorizontalAlignment.LEFT,
new SpriteContainerEmpty());
}
@Override
public void drawU(UGraphic ug) {
if (url != null)
ug.startUrl(url);
final String displayString = getTask().getDisplayString();
final Style style = getStyle();
final ClockwiseTopRightBottomLeft margin = style.getMargin();
ug = ug.apply(UTranslate.dy(margin.getTop()));
final double x1 = timeScale.getStartingPosition(start);
ug = ug.apply(UTranslate.dx(x1));
if (displayString == null) {
final double x2 = timeScale.getEndingPosition(start);
final double width = getDiamondHeight();
final double delta = x2 - x1 - width;
ug = ug.apply(UTranslate.dx(delta / 2));
drawShape(applyColors(ug));
} else {
final TextBlock draw = Display.getWithNewlines(displayString).create(getFontConfiguration(),
HorizontalAlignment.LEFT, new SpriteContainerEmpty());
draw.drawU(ug);
}
if (url != null)
ug.closeUrl();
}
private UGraphic applyColors(UGraphic ug) {
final CenterBorderColor col = this.getColors();
if (col != null && col.isOk())
return col.apply(ug);
return ug.apply(getLineColor()).apply(getBackgroundColor().bg());
}
private void drawShape(UGraphic ug) {
ug.draw(getDiamond());
}
@Override
public FingerPrint getFingerPrintNote(StringBounder stringBounder) {
return null;
}
@Override
public FingerPrint getFingerPrint(StringBounder stringBounder) {
final double h = getFullHeightTask(stringBounder);
final double startPos = timeScale.getStartingPosition(start);
return new FingerPrint(startPos, getY(stringBounder).getCurrentValue(), startPos + h,
getY(stringBounder).getCurrentValue() + h);
}
private UShape getDiamond() {
final double h = getDiamondHeight();
final UPolygon result = new UPolygon();
result.addPoint(h / 2, 0);
result.addPoint(h, h / 2);
result.addPoint(h / 2, h);
result.addPoint(0, h / 2);
return result;
}
@Override
public double getX1(TaskAttribute taskAttribute) {
final double x1 = timeScale.getStartingPosition(start);
final double x2 = timeScale.getEndingPosition(start);
final double width = getDiamondHeight();
final double delta = x2 - x1 - width;
return x1 + delta;
}
@Override
public double getX2(TaskAttribute taskAttribute) {
final double x1 = timeScale.getStartingPosition(start);
final double x2 = timeScale.getEndingPosition(start);
final double width = getDiamondHeight();
final double delta = x2 - x1 - width;
return x2 - delta;
}
}