-
Notifications
You must be signed in to change notification settings - Fork 2
/
EdgeGroupingDemo.java
300 lines (264 loc) · 10.8 KB
/
EdgeGroupingDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/****************************************************************************
**
** This demo file is part of yFiles for JavaFX 3.6.
**
** Copyright (c) 2000-2023 by yWorks GmbH, Vor dem Kreuzberg 28,
** 72070 Tuebingen, Germany. All rights reserved.
**
** yFiles demo files exhibit yFiles for JavaFX functionalities. Any redistribution
** of demo files in source code or binary form, with or without
** modification, is not permitted.
**
** Owners of a valid software license for a yFiles for JavaFX version that this
** demo is shipped with are allowed to use the demo source code as basis
** for their own yFiles for JavaFX powered applications. Use of such programs is
** governed by the rights and conditions as set out in the yFiles for JavaFX
** license agreement.
**
** THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY EXPRESS OR IMPLIED
** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
** NO EVENT SHALL yWorks BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
** TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
***************************************************************************/
package layout.edgegrouping;
import com.yworks.yfiles.geometry.SizeD;
import com.yworks.yfiles.graph.IEdge;
import com.yworks.yfiles.graph.IGraph;
import com.yworks.yfiles.graph.IMapper;
import com.yworks.yfiles.graph.INodeDefaults;
import com.yworks.yfiles.graph.Mapper;
import com.yworks.yfiles.graph.styles.Arrow;
import com.yworks.yfiles.graph.styles.ArrowType;
import com.yworks.yfiles.graph.styles.NodeStylePortStyleAdapter;
import com.yworks.yfiles.graph.styles.PolylineEdgeStyle;
import com.yworks.yfiles.graph.styles.RectangleNodeStyle;
import com.yworks.yfiles.graph.styles.ShapeNodeShape;
import com.yworks.yfiles.graph.styles.ShapeNodeStyle;
import com.yworks.yfiles.graph.styles.VoidPortStyle;
import com.yworks.yfiles.graphml.GraphMLIOHandler;
import com.yworks.yfiles.layout.hierarchic.HierarchicLayout;
import com.yworks.yfiles.layout.hierarchic.HierarchicLayoutData;
import com.yworks.yfiles.layout.hierarchic.IncrementalHintItemMapping;
import com.yworks.yfiles.layout.hierarchic.LayoutMode;
import com.yworks.yfiles.layout.hierarchic.SimplexNodePlacer;
import com.yworks.yfiles.view.BridgeCrossingStyle;
import com.yworks.yfiles.view.BridgeManager;
import com.yworks.yfiles.view.GraphControl;
import com.yworks.yfiles.view.GraphObstacleProvider;
import com.yworks.yfiles.view.Pen;
import com.yworks.yfiles.view.input.GraphViewerInputMode;
import toolkit.DemoApplication;
import toolkit.DemoStyles;
import toolkit.Themes;
import toolkit.WebViewUtils;
import javafx.scene.paint.Color;
import javafx.scene.web.WebView;
import java.io.IOException;
import java.time.Duration;
/**
* Shows the effects of edge and port grouping when arranging graphs with
* {@link HierarchicLayout}.
*/
public class EdgeGroupingDemo extends DemoApplication {
public WebView helpView;
public GraphControl graphControl;
/** Holds group IDs for the edges' source end. */
private IMapper<IEdge, Object> sourceGroupIdMapper;
/** Holds group IDs for the edges' target end. */
private IMapper<IEdge, Object> targetGroupIdMapper;
/**
* Specifies if the layout algorithm should use edge or port grouping.
*/
private boolean portGroupMode = false;
/**
* Toggles the grouping mode and calculates a new incremental layout.
*/
public void toggleGrouping() {
portGroupMode = !portGroupMode;
updateEdgeStyles(graphControl.getGraph());
runLayout(true);
}
/**
* Initializes the demo.
*/
public void initialize() {
// enable interactive navigation such as panning
graphControl.setInputMode(new GraphViewerInputMode());
// creates mappers for storing group IDs
createMappers();
// configure default node, edge and arrow styles.
configureBridges();
// load a sample GraphML file with suitable group IDs
loadGraph();
// set the color and port styles for edges according to their grouping
updateEdgeStyles(graphControl.getGraph());
// calculate an initial arrangement for the sample graph
runLayout(false);
WebViewUtils.initHelp(helpView, this);
}
/**
* Arranges the displayed graph using the {@link HierarchicLayout} algorithm.
* @param incremental if {@code true} the algorithm will take "old" positions
* of nodes into account; otherwise old position will have no effect on the
* resulting arrangement.
*/
private void runLayout( boolean incremental ) {
HierarchicLayout layout = new HierarchicLayout();
layout.setOrthogonalRoutingEnabled(true);
layout.setMinimumLayerDistance(70);
layout.setLayoutMode(incremental ? LayoutMode.INCREMENTAL : LayoutMode.FROM_SCRATCH);
SimplexNodePlacer nodePlacer = new SimplexNodePlacer();
nodePlacer.setBarycenterModeEnabled(true);
nodePlacer.setBendReduction(false);
layout.setNodePlacer(nodePlacer);
HierarchicLayoutData layoutData = new HierarchicLayoutData();
layoutData.setEdgeThickness(3);
IncrementalHintItemMapping incrementalHintItemMapping = new IncrementalHintItemMapping();
incrementalHintItemMapping.setIncrementalSequencingItems(item -> item instanceof IEdge);
layoutData.setIncrementalHints(incrementalHintItemMapping);
if (portGroupMode) {
layoutData.setSourcePortGroupIds(sourceGroupIdMapper);
layoutData.setTargetPortGroupIds(targetGroupIdMapper);
} else {
layoutData.setSourceGroupIds(sourceGroupIdMapper);
layoutData.setTargetGroupIds(targetGroupIdMapper);
}
graphControl.morphLayout(layout, Duration.ofMillis(700), layoutData);
}
/**
* Creates the mappers used for storing group IDs required for edge and port
* grouping.
*/
private void createMappers() {
sourceGroupIdMapper = new Mapper<>();
targetGroupIdMapper = new Mapper<>();
}
/**
* Adds a {@link BridgeManager} for easier distinction between edge groups
* and edge crossings.
*/
private void configureBridges() {
BridgeManager bridgeManager = new BridgeManager();
bridgeManager.setCanvasControl(graphControl);
bridgeManager.setDefaultBridgeCrossingStyle(BridgeCrossingStyle.GAP);
bridgeManager.addObstacleProvider(new GraphObstacleProvider());
}
/**
* Updates all edge styles according to the grouping type used for the
* corresponding edges. In this context, grouping type means
* "source grouping", "target grouping", or "source and target grouping".
*/
private void updateEdgeStyles( IGraph graph ) {
for (IEdge edge : graph.getEdges()) {
applyEdgeStyle(graph, edge);
}
}
/**
* Adjusts the styles of the given edge and its ports depending on grouping
* type. In this context, grouping type means "source grouping", "target
* grouping", or "source and target grouping".
*/
private void applyEdgeStyle( IGraph graph, IEdge edge ) {
Object srcGrpId = sourceGroupIdMapper.getValue(edge);
Object tgtGrpId = targetGroupIdMapper.getValue(edge);
if (srcGrpId == null && tgtGrpId == null) {
// the ungrouped edge default
return;
}
// distinguish edges by color depending on grouping type (i.e. source
// grouping, target grouping, or source and target grouping
Color color = getEdgeColor(srcGrpId, tgtGrpId);
// leverage ShapeNodeStyle to create a simple cycle visualization for ports
ShapeNodeStyle nodeStyle = new ShapeNodeStyle();
nodeStyle.setShape(ShapeNodeShape.ELLIPSE);
nodeStyle.setPaint(color);
nodeStyle.setPen(null);
NodeStylePortStyleAdapter portStyleAdapter = new NodeStylePortStyleAdapter();
portStyleAdapter.setNodeStyle(nodeStyle);
portStyleAdapter.setRenderSize(new SizeD(7, 7));
// apply port style
if (srcGrpId != null) {
graph.setStyle(edge.getSourcePort(), portStyleAdapter);
} else {
graph.setStyle(edge.getSourcePort(), VoidPortStyle.INSTANCE);
}
if (tgtGrpId != null) {
graph.setStyle(edge.getTargetPort(), portStyleAdapter);
} else {
graph.setStyle(edge.getTargetPort(), VoidPortStyle.INSTANCE);
}
// apply edge style
PolylineEdgeStyle edgeStyle = new PolylineEdgeStyle();
edgeStyle.setPen(new Pen(color, 3));
edgeStyle.setTargetArrow(new Arrow(ArrowType.DEFAULT, color));
edgeStyle.setSmoothingLength(15);
graph.setStyle(edge, edgeStyle);
}
/**
* Determines a edge path color for distinguishing edges by grouping type.
* In this context, grouping type means "source grouping", "target grouping",
* or "source and target grouping".
*/
private Color getEdgeColor( Object srcGrpId, Object tgtGrpId ) {
if (portGroupMode) {
if (srcGrpId == null) {
// target grouped
return Color.CHOCOLATE;
} else if (tgtGrpId == null) {
// source grouped
return Color.CRIMSON;
} else {
// source and target grouped
return Color.DARKORANGE;
}
} else {
if (srcGrpId == null) {
// target grouped
return Color.DARKSLATEBLUE;
} else if (tgtGrpId == null) {
// source grouped
return Color.ROYALBLUE;
} else {
// source and target grouped
return Color.CORNFLOWERBLUE;
}
}
}
/**
* Loads a sample graph. Populates {@link #sourceGroupIdMapper source} and
* {@link #targetGroupIdMapper target} group IDs from data in the GraphML
* file.
*/
private void loadGraph() {
IGraph graph = graphControl.getGraph();
DemoStyles.initDemoStyles(graph);
RectangleNodeStyle nodeStyle = DemoStyles.createDemoNodeStyle(Themes.PALETTE44);
INodeDefaults nodeDefaults = graph.getNodeDefaults();
nodeDefaults.setStyle(nodeStyle);
nodeDefaults.setSize(new SizeD(50, 30));
PolylineEdgeStyle edgeStyle = new PolylineEdgeStyle();
Color edgeColor = Color.rgb(0xBB, 0xBB, 0xBB);
edgeStyle.setPen(new Pen(edgeColor, 3));
edgeStyle.setTargetArrow(new Arrow(ArrowType.TRIANGLE, edgeColor));
edgeStyle.setSmoothingLength(15);
graph.getEdgeDefaults().setStyle(edgeStyle);
GraphMLIOHandler graphMLIOHandler = graphControl.getGraphMLIOHandler();
graphMLIOHandler.addInputMapper(IEdge.class, Object.class, "sourceGroupId", sourceGroupIdMapper);
graphMLIOHandler.addInputMapper(IEdge.class, Object.class, "targetGroupId", targetGroupIdMapper);
try {
graphControl.importFromGraphML(getClass().getResource("resources/sample.graphml"));
} catch (IOException e) {
e.printStackTrace();
}
}
public static void main(String[] args) {
launch(args);
}
}