Skip to content

Commit

Permalink
add support for top-down layout
Browse files Browse the repository at this point in the history
  • Loading branch information
@NiklasRentzCAU
NiklasRentzCAU committed Nov 27, 2024
1 parent 550a06d commit 7b76497
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 3 deletions.
20 changes: 18 additions & 2 deletions ....kieler.spviz.spviz/src/de/cau/cs/kieler/spviz/spviz/generator/GenerateSubSyntheses.xtend
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ class GenerateSubSyntheses {
import de.cau.cs.kieler.klighd.kgraph.KGraphFactory
import de.cau.cs.kieler.klighd.kgraph.KIdentifier
import de.cau.cs.kieler.klighd.kgraph.KNode
import de.cau.cs.kieler.klighd.krendering.extensions.KContainerRenderingExtensions
import de.cau.cs.kieler.klighd.krendering.extensions.KEdgeExtensions
import de.cau.cs.kieler.klighd.krendering.extensions.KNodeExtensions
import de.cau.cs.kieler.klighd.krendering.extensions.KPortExtensions
Expand Down Expand Up @@ -100,16 +101,17 @@ class GenerateSubSyntheses {
import «data.bundleNamePrefix».model.«categoryConnection.connectingCategory.name.toFirstUpper»CategoryConnects«categoryConnection.connectedCategory.name.toFirstUpper»Via«(categoryConnection.connection.connecting).name.toFirstUpper»Dot«categoryConnection.connection.name.toFirstUpper»Container
«ENDFOR»
import static «data.getBundleNamePrefix».viz.Options.*
import static extension de.cau.cs.kieler.klighd.syntheses.DiagramSyntheses.*
import static extension «data.getBundleNamePrefix».viz.Options.*
import static extension «data.getBundleNamePrefix».viz.SynthesisUtils.*
import static extension «data.getBundleNamePrefix».model.util.ContextExtensions.*
/**
* Transformation as an overview of all «viewName.toFirstLower»s in the given list of «viewName.toFirstLower»s.
*/
class «viewName»OverviewSynthesis extends AbstractSubSynthesis<«viewName»OverviewContext, KNode> {
@Inject extension KContainerRenderingExtensions
@Inject extension KEdgeExtensions
@Inject extension KNodeExtensions
@Inject extension KPortExtensions
Expand All @@ -132,6 +134,9 @@ class GenerateSubSyntheses {
setLayoutOption(LayeredOptions::CONSIDER_MODEL_ORDER_STRATEGY, OrderingStrategy::NODES_AND_EDGES)
setLayoutOption(CoreOptions::DIRECTION, Direction.RIGHT)
setLayoutOption(CoreOptions::NODE_SIZE_CONSTRAINTS, EnumSet.of(SizeConstraint.MINIMUM_SIZE))
if (TOPDOWN_LAYOUT.booleanValue) {
SynthesisUtils.configureTopdownLayout(it, false)
}
val isFocus = context.rootVisualization.focus === context
addOverviewRendering("«viewName»", context.overviewText, context.isExpanded, «!view.shownConnections.empty || !view.shownCategoryConnections.empty», isFocus, usedContext)
Expand Down Expand Up @@ -261,6 +266,9 @@ class GenerateSubSyntheses {
createNode => [
associateWith(«viewName.toFirstLower»OverviewContext)
configureBoxLayout
if (TOPDOWN_LAYOUT.booleanValue) {
SynthesisUtils.configureTopdownLayout(it, false)
}
«FOR shownElement : view.shownElements BEFORE "addOverviewOfCollapsedRendering(shown, " SEPARATOR " || " AFTER ", usedContext)"»«««
« »!«viewName.toFirstLower»OverviewContext.collapsed«shownElement.shownElement.name.toFirstUpper»Contexts.isEmpty«««
« »«ENDFOR»
Expand Down Expand Up @@ -305,7 +313,12 @@ class GenerateSubSyntheses {
createNode => [
associateWith(context)
configureOverviewLayout
addInvisibleContainerRendering
if (TOPDOWN_LAYOUT.booleanValue) {
SynthesisUtils.configureTopdownLayout(it, false)
}
addInvisibleContainerRendering => [
addChildArea
]
tooltip = context.overviewText
«FOR shownElement : view.shownElements»
Expand Down Expand Up @@ -741,6 +754,9 @@ class GenerateSubSyntheses {
setLayoutOption(LayeredOptions::CONSIDER_MODEL_ORDER_STRATEGY, OrderingStrategy::NODES_AND_EDGES)
setLayoutOption(CoreOptions::DIRECTION, Direction.RIGHT)
setLayoutOption(CoreOptions::EDGE_ROUTING, EdgeRouting.POLYLINE)
if (TOPDOWN_LAYOUT.booleanValue) {
SynthesisUtils.configureTopdownLayout(it, false)
}
«FOR containedView : containedViews»
// Show a «containedView.view.name.toFirstLower» overview within this «artifactName»
Expand Down
38 changes: 37 additions & 1 deletion ....cs.kieler.spviz.spviz/src/de/cau/cs/kieler/spviz/spviz/generator/GenerateSyntheses.xtend
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,16 @@ class GenerateSyntheses {
// Add all performance options.
options.addAll(SHOW_ICONS)
options.add(TOPDOWN_LAYOUT)
return options.toList
}
override transform(«data.projectName» model) {
val modelNode = createNode.associateWith(model)
if (TOPDOWN_LAYOUT.booleanValue) {
SynthesisUtils.configureTopdownLayout(modelNode, true)
}
// Create a view with the currently stored visualization context in mind. If there is no current context, create
// a new one for the general model overview and store that for later use.
Expand Down Expand Up @@ -189,7 +194,9 @@ class GenerateSyntheses {
associateWith(model)
data += createKIdentifier => [ it.id = visContext.hashCode.toString ]
SynthesisUtils.configureBoxLayout(it)
setLayoutOption(BoxLayouterOptions.BOX_PACKING_MODE, PackingMode.GROUP_MIXED)
if (TOPDOWN_LAYOUT.booleanValue) {
SynthesisUtils.configureTopdownLayout(it, false)
}
addProjectRendering
«FOR view : data.views»
Expand Down Expand Up @@ -663,6 +670,7 @@ class GenerateSyntheses {
val actionId = ShowHideCollapsedAction::ID
val doWhat = shown ? "Hide" : "Show"
node.addInvisibleContainerRendering => [
addChildArea
// Button to show/hide this overview
val interactiveButtons = context.getOptionValue(INTERACTIVE_BUTTONS) as Boolean
if (interactiveButtons) {
Expand Down Expand Up @@ -1207,15 +1215,19 @@ class GenerateSyntheses {
import de.cau.cs.kieler.klighd.syntheses.DiagramSyntheses
import «data.getBundleNamePrefix».model.IOverviewVisualizationContext
import «data.getBundleNamePrefix».model.IVisualizationContext
import java.util.EnumSet
import java.util.List
import java.util.Set
import org.eclipse.elk.alg.layered.components.ComponentOrderingStrategy
import org.eclipse.elk.alg.layered.options.LayeredOptions
import org.eclipse.elk.alg.layered.options.OrderingStrategy
import org.eclipse.elk.core.options.ContentAlignment
import org.eclipse.elk.core.options.CoreOptions
import org.eclipse.elk.core.options.Direction
import org.eclipse.elk.core.options.EdgeRouting
import org.eclipse.elk.core.options.PortConstraints
import org.eclipse.elk.core.options.TopdownSizeApproximator
import org.eclipse.elk.core.options.TopdownNodeTypes
«FOR artifact : data.artifacts»
import «data.modelBundleNamePrefix».model.«artifact.name.toFirstUpper»
Expand Down Expand Up @@ -1395,6 +1407,27 @@ class GenerateSyntheses {
}
«ENDFOR»

/**
* Configures top-down layout for the given node.
*
* @param node The node to configure.
* @param root If the {@code node} is the graph's root node.
*/
def static void configureTopdownLayout(KNode node, boolean root) {
node => [
setLayoutOption(CoreOptions::TOPDOWN_LAYOUT, true)
setLayoutOption(CoreOptions::NODE_SIZE_FIXED_GRAPH_SIZE, true)
setLayoutOption(CoreOptions::TOPDOWN_NODE_TYPE, root ? TopdownNodeTypes.ROOT_NODE : TopdownNodeTypes.HIERARCHICAL_NODE)
setLayoutOption(CoreOptions::TOPDOWN_HIERARCHICAL_NODE_WIDTH, 150d)
setLayoutOption(CoreOptions::TOPDOWN_HIERARCHICAL_NODE_ASPECT_RATIO, 1.41d)
setLayoutOption(CoreOptions::TOPDOWN_SCALE_CAP, 1.0)
setLayoutOption(CoreOptions.TOPDOWN_SIZE_APPROXIMATOR, TopdownSizeApproximator.COUNT_CHILDREN)
if (!root) setLayoutOption(CoreOptions.CONTENT_ALIGNMENT, EnumSet.of(ContentAlignment.V_CENTER, ContentAlignment.H_CENTER))
]
}


/**
* Configures the layout of any overview node. Configures the box layout algorithm of elk.
*/
Expand Down Expand Up @@ -1697,6 +1730,9 @@ class GenerateSyntheses {
public static final SynthesisOption SHOW_ICONS = SynthesisOption.createCheckOption("Icons", true)
.setCategory(PERFORMANCE)
.description = "Use images as icons for the buttons. Inflates the view model and reduces performance for a cleaner view."

public static final SynthesisOption TOPDOWN_LAYOUT = SynthesisOption.createCheckOption("Topdown Layout", false)
.description = "Switch between ELK'S top-down and bottom-up layout."
}

'''
Expand Down

0 comments on commit 7b76497

Please sign in to comment.