net.sourceforge.plantuml.abel.EntityPosition 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.abel;
import java.util.EnumSet;
import net.sourceforge.plantuml.klimt.Shadowable;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.geom.Rankdir;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.svek.ShapeType;
public enum EntityPosition {
NORMAL, ENTRY_POINT, EXIT_POINT, INPUT_PIN, OUTPUT_PIN, EXPANSION_INPUT, EXPANSION_OUTPUT, PORTIN, PORTOUT;
public static final double RADIUS = 6;
public static EnumSet getInputs() {
return EnumSet.of(ENTRY_POINT, INPUT_PIN, EXPANSION_INPUT, PORTIN);
}
public static EnumSet getOutputs() {
return EnumSet.of(EXIT_POINT, OUTPUT_PIN, EXPANSION_OUTPUT, PORTOUT);
}
public static EnumSet getNormals() {
return EnumSet.of(NORMAL);
}
public boolean isNormal() {
return this == NORMAL;
}
public boolean isInput() {
return getInputs().contains(this);
}
public boolean isOutput() {
return getOutputs().contains(this);
}
public void drawSymbol(UGraphic ug, Rankdir rankdir) {
if (this == NORMAL) {
throw new IllegalStateException();
} else if (this == ENTRY_POINT || this == EXIT_POINT) {
final Shadowable circle = UEllipse.build(RADIUS * 2, RADIUS * 2);
ug.draw(circle);
if (this == EntityPosition.EXIT_POINT) {
final double xc = 0 + RADIUS + .5;
final double yc = 0 + RADIUS + .5;
final double radius = RADIUS - .5;
drawLine(ug, getPointOnCircle(xc, yc, Math.PI / 4, radius),
getPointOnCircle(xc, yc, Math.PI + Math.PI / 4, radius));
drawLine(ug, getPointOnCircle(xc, yc, -Math.PI / 4, radius),
getPointOnCircle(xc, yc, Math.PI - Math.PI / 4, radius));
}
} else if (this == INPUT_PIN || this == OUTPUT_PIN /* || this == PORT */) {
final Shadowable rectangle = URectangle.build(RADIUS * 2, RADIUS * 2);
ug.draw(rectangle);
} else if (this == EXPANSION_INPUT || this == EXPANSION_OUTPUT) {
if (rankdir == Rankdir.TOP_TO_BOTTOM) {
final Shadowable rectangle = URectangle.build(RADIUS * 2 * 4, RADIUS * 2);
ug.draw(rectangle);
final ULine vline = ULine.vline(RADIUS * 2);
ug.apply(UTranslate.dx(RADIUS * 2)).draw(vline);
ug.apply(UTranslate.dx(RADIUS * 2 * 2)).draw(vline);
ug.apply(UTranslate.dx(RADIUS * 2 * 3)).draw(vline);
} else {
final Shadowable rectangle = URectangle.build(RADIUS * 2, RADIUS * 2 * 4);
ug.apply(UTranslate.dy(0)).draw(rectangle);
final ULine hline = ULine.hline(RADIUS * 2);
ug.apply(UTranslate.dy(RADIUS * 2)).draw(hline);
ug.apply(UTranslate.dy(RADIUS * 2 * 2)).draw(hline);
ug.apply(UTranslate.dy(RADIUS * 2 * 3)).draw(hline);
}
}
}
public XDimension2D getDimension(Rankdir rankdir) {
if (this == EXPANSION_INPUT || this == EXPANSION_OUTPUT) {
if (rankdir == Rankdir.TOP_TO_BOTTOM)
return new XDimension2D(EntityPosition.RADIUS * 2 * 4, EntityPosition.RADIUS * 2);
return new XDimension2D(EntityPosition.RADIUS * 2, EntityPosition.RADIUS * 2 * 4);
}
return new XDimension2D(EntityPosition.RADIUS * 2, EntityPosition.RADIUS * 2);
}
private XPoint2D getPointOnCircle(double xc, double yc, double angle, double radius) {
final double x = xc + radius * Math.cos(angle);
final double y = yc + radius * Math.sin(angle);
return new XPoint2D(x, y);
}
static private void drawLine(UGraphic ug, XPoint2D p1, XPoint2D p2) {
final double dx = p2.getX() - p1.getX();
final double dy = p2.getY() - p1.getY();
ug.apply(new UTranslate(p1.getX(), p1.getY())).draw(new ULine(dx, dy));
}
public ShapeType getShapeType() {
if (this == NORMAL)
throw new IllegalStateException();
if (this == ENTRY_POINT || this == EXIT_POINT)
return ShapeType.RECTANGLE_PORT;
return ShapeType.RECTANGLE;
}
public static EntityPosition fromStereotype(String label) {
if ("<>".equalsIgnoreCase(label))
throw new UnsupportedOperationException();
if ("<>".equalsIgnoreCase(label))
return ENTRY_POINT;
if ("<>".equalsIgnoreCase(label))
return EXIT_POINT;
if ("<>".equalsIgnoreCase(label))
return INPUT_PIN;
if ("<>".equalsIgnoreCase(label))
return OUTPUT_PIN;
if ("<>".equalsIgnoreCase(label))
return EXPANSION_INPUT;
if ("<>".equalsIgnoreCase(label))
return EXPANSION_OUTPUT;
return EntityPosition.NORMAL;
}
// public static EnumSet getSame() {
// return EnumSet.of(PORT);
// }
//
public boolean isPort() {
return /* this == PORT || */ this == PORTIN || this == PORTOUT;
}
public boolean usePortP() {
return isPort() || this == EXIT_POINT || this == ENTRY_POINT;
}
}