d2/d2layouts/d2cycle/layout.go

294 lines
7.6 KiB
Go
Raw Normal View History

2025-02-21 16:34:23 +00:00
package d2cycle
import (
2025-02-22 10:36:51 +00:00
"context"
"math"
2025-02-22 10:37:44 +00:00
"sort"
2025-02-21 16:34:23 +00:00
2025-02-22 10:36:51 +00:00
"oss.terrastruct.com/d2/d2graph"
"oss.terrastruct.com/d2/lib/geo"
"oss.terrastruct.com/d2/lib/label"
"oss.terrastruct.com/util-go/go2"
2025-02-21 16:34:23 +00:00
)
const (
2025-02-22 10:36:51 +00:00
MIN_RADIUS = 200
PADDING = 20
MIN_SEGMENT_LEN = 10
2025-02-22 13:47:57 +00:00
ARC_STEPS = 100
2025-02-21 16:34:23 +00:00
)
2025-02-22 10:37:44 +00:00
// Layout lays out the graph and computes curved edge routes.
2025-02-21 16:34:23 +00:00
func Layout(ctx context.Context, g *d2graph.Graph, layout d2graph.LayoutGraph) error {
2025-02-22 10:36:51 +00:00
objects := g.Root.ChildrenArray
if len(objects) == 0 {
return nil
}
2025-02-21 17:41:31 +00:00
2025-02-22 10:36:51 +00:00
for _, obj := range g.Objects {
positionLabelsIcons(obj)
}
2025-02-21 17:41:31 +00:00
2025-02-22 10:36:51 +00:00
radius := calculateRadius(objects)
positionObjects(objects, radius)
2025-02-21 17:41:31 +00:00
2025-02-22 10:36:51 +00:00
for _, edge := range g.Edges {
2025-02-22 10:37:44 +00:00
createCircularArc(edge)
2025-02-22 10:36:51 +00:00
}
2025-02-21 17:41:31 +00:00
2025-02-22 10:36:51 +00:00
return nil
2025-02-21 16:34:23 +00:00
}
2025-02-21 17:29:24 +00:00
func calculateRadius(objects []*d2graph.Object) float64 {
2025-02-22 10:36:51 +00:00
numObjects := float64(len(objects))
maxSize := 0.0
for _, obj := range objects {
size := math.Max(obj.Box.Width, obj.Box.Height)
maxSize = math.Max(maxSize, size)
}
minRadius := (maxSize/2.0 + PADDING) / math.Sin(math.Pi/numObjects)
return math.Max(minRadius, MIN_RADIUS)
2025-02-21 16:34:23 +00:00
}
func positionObjects(objects []*d2graph.Object, radius float64) {
2025-02-22 10:36:51 +00:00
numObjects := float64(len(objects))
angleOffset := -math.Pi / 2
for i, obj := range objects {
angle := angleOffset + (2*math.Pi*float64(i)/numObjects)
x := radius * math.Cos(angle)
y := radius * math.Sin(angle)
obj.TopLeft = geo.NewPoint(
x-obj.Box.Width/2,
y-obj.Box.Height/2,
)
}
2025-02-21 16:34:23 +00:00
}
2025-02-22 10:37:44 +00:00
func createCircularArc(edge *d2graph.Edge) {
2025-02-22 10:50:31 +00:00
if edge.Src == nil || edge.Dst == nil {
return
}
srcCenter := edge.Src.Center()
dstCenter := edge.Dst.Center()
srcAngle := math.Atan2(srcCenter.Y, srcCenter.X)
dstAngle := math.Atan2(dstCenter.Y, dstCenter.X)
2025-02-22 13:35:53 +00:00
if dstAngle < srcAngle {
dstAngle += 2 * math.Pi
2025-02-22 10:50:31 +00:00
}
arcRadius := math.Hypot(srcCenter.X, srcCenter.Y)
2025-02-22 11:05:45 +00:00
2025-02-22 11:06:24 +00:00
path := make([]*geo.Point, 0, ARC_STEPS+1)
2025-02-22 10:50:31 +00:00
for i := 0; i <= ARC_STEPS; i++ {
t := float64(i) / float64(ARC_STEPS)
angle := srcAngle + t*(dstAngle-srcAngle)
x := arcRadius * math.Cos(angle)
y := arcRadius * math.Sin(angle)
path = append(path, geo.NewPoint(x, y))
}
2025-02-22 11:06:24 +00:00
path[0] = srcCenter
path[len(path)-1] = dstCenter
2025-02-22 10:50:31 +00:00
2025-02-22 11:06:24 +00:00
// Clamp endpoints to the boundaries of the source and destination boxes.
_, newSrc := clampPointOutsideBox(edge.Src.Box, path, 0)
_, newDst := clampPointOutsideBoxReverse(edge.Dst.Box, path, len(path)-1)
path[0] = newSrc
path[len(path)-1] = newDst
// Trim redundant path points that fall inside node boundaries.
2025-02-22 13:42:00 +00:00
path = trimPathPoints(path, edge.Src.Box)
path = trimPathPoints(path, edge.Dst.Box)
2025-02-22 13:35:53 +00:00
2025-02-22 13:40:50 +00:00
edge.Route = path
edge.IsCurve = true
2025-02-22 13:35:53 +00:00
}
2025-02-22 10:50:31 +00:00
2025-02-22 11:06:24 +00:00
2025-02-22 10:37:44 +00:00
// clampPointOutsideBox walks forward along the path until it finds a point outside the box,
// then replaces the point with a precise intersection.
func clampPointOutsideBox(box *geo.Box, path []*geo.Point, startIdx int) (int, *geo.Point) {
if startIdx >= len(path)-1 {
return startIdx, path[startIdx]
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:37:44 +00:00
if !boxContains(box, path[startIdx]) {
return startIdx, path[startIdx]
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:37:44 +00:00
for i := startIdx + 1; i < len(path); i++ {
if boxContains(box, path[i]) {
continue
}
seg := geo.NewSegment(path[i-1], path[i])
inter := findPreciseIntersection(box, *seg)
if inter != nil {
return i, inter
}
return i, path[i]
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:37:44 +00:00
return len(path)-1, path[len(path)-1]
2025-02-21 19:24:57 +00:00
}
2025-02-21 17:41:31 +00:00
2025-02-22 10:37:44 +00:00
// clampPointOutsideBoxReverse works similarly but in reverse order.
func clampPointOutsideBoxReverse(box *geo.Box, path []*geo.Point, endIdx int) (int, *geo.Point) {
if endIdx <= 0 {
return endIdx, path[endIdx]
}
if !boxContains(box, path[endIdx]) {
return endIdx, path[endIdx]
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:37:44 +00:00
for j := endIdx - 1; j >= 0; j-- {
if boxContains(box, path[j]) {
continue
}
seg := geo.NewSegment(path[j], path[j+1])
inter := findPreciseIntersection(box, *seg)
if inter != nil {
return j, inter
}
return j, path[j]
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:37:44 +00:00
return 0, path[0]
2025-02-21 19:24:57 +00:00
}
2025-02-22 10:37:44 +00:00
// findPreciseIntersection calculates intersection points between seg and all four sides of the box,
// then returns the intersection closest to seg.Start.
func findPreciseIntersection(box *geo.Box, seg geo.Segment) *geo.Point {
intersections := []struct {
point *geo.Point
t float64
}{}
2025-02-22 10:36:51 +00:00
left := box.TopLeft.X
right := box.TopLeft.X + box.Width
top := box.TopLeft.Y
bottom := box.TopLeft.Y + box.Height
2025-02-22 10:37:44 +00:00
dx := seg.End.X - seg.Start.X
dy := seg.End.Y - seg.Start.Y
// Check vertical boundaries.
if dx != 0 {
// Left boundary.
t := (left - seg.Start.X) / dx
if t >= 0 && t <= 1 {
y := seg.Start.Y + t*dy
if y >= top && y <= bottom {
intersections = append(intersections, struct {
point *geo.Point
t float64
}{geo.NewPoint(left, y), t})
}
}
// Right boundary.
t = (right - seg.Start.X) / dx
if t >= 0 && t <= 1 {
y := seg.Start.Y + t*dy
if y >= top && y <= bottom {
intersections = append(intersections, struct {
point *geo.Point
t float64
}{geo.NewPoint(right, y), t})
}
}
}
// Check horizontal boundaries.
if dy != 0 {
// Top boundary.
t := (top - seg.Start.Y) / dy
if t >= 0 && t <= 1 {
x := seg.Start.X + t*dx
if x >= left && x <= right {
intersections = append(intersections, struct {
point *geo.Point
t float64
}{geo.NewPoint(x, top), t})
}
}
// Bottom boundary.
t = (bottom - seg.Start.Y) / dy
if t >= 0 && t <= 1 {
x := seg.Start.X + t*dx
if x >= left && x <= right {
intersections = append(intersections, struct {
point *geo.Point
t float64
}{geo.NewPoint(x, bottom), t})
}
}
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:37:44 +00:00
if len(intersections) == 0 {
return nil
}
// Sort intersections by t (distance from seg.Start) and return the closest.
sort.Slice(intersections, func(i, j int) bool {
return intersections[i].t < intersections[j].t
})
return intersections[0].point
2025-02-22 10:36:51 +00:00
}
2025-02-22 10:42:02 +00:00
// trimPathPoints removes intermediate points that fall inside the given box while preserving endpoints.
func trimPathPoints(path []*geo.Point, box *geo.Box) []*geo.Point {
if len(path) <= 2 {
return path
2025-02-22 10:37:44 +00:00
}
2025-02-22 10:42:02 +00:00
trimmed := []*geo.Point{path[0]}
for i := 1; i < len(path)-1; i++ {
if !boxContains(box, path[i]) {
trimmed = append(trimmed, path[i])
}
2025-02-22 10:37:44 +00:00
}
2025-02-22 10:42:02 +00:00
trimmed = append(trimmed, path[len(path)-1])
return trimmed
2025-02-22 10:37:44 +00:00
}
// boxContains uses strict inequalities so that points exactly on the boundary are considered outside.
2025-02-22 10:32:46 +00:00
func boxContains(b *geo.Box, p *geo.Point) bool {
2025-02-22 10:37:44 +00:00
return p.X > b.TopLeft.X &&
p.X < b.TopLeft.X+b.Width &&
p.Y > b.TopLeft.Y &&
p.Y < b.TopLeft.Y+b.Height
2025-02-21 17:41:31 +00:00
}
func positionLabelsIcons(obj *d2graph.Object) {
2025-02-22 10:36:51 +00:00
if obj.Icon != nil && obj.IconPosition == nil {
if len(obj.ChildrenArray) > 0 {
obj.IconPosition = go2.Pointer(label.OutsideTopLeft.String())
if obj.LabelPosition == nil {
obj.LabelPosition = go2.Pointer(label.OutsideTopRight.String())
return
}
} else if obj.SQLTable != nil || obj.Class != nil || obj.Language != "" {
obj.IconPosition = go2.Pointer(label.OutsideTopLeft.String())
} else {
obj.IconPosition = go2.Pointer(label.InsideMiddleCenter.String())
}
}
if obj.HasLabel() && obj.LabelPosition == nil {
if len(obj.ChildrenArray) > 0 {
obj.LabelPosition = go2.Pointer(label.OutsideTopCenter.String())
} else if obj.HasOutsideBottomLabel() {
obj.LabelPosition = go2.Pointer(label.OutsideBottomCenter.String())
} else if obj.Icon != nil {
obj.LabelPosition = go2.Pointer(label.InsideTopCenter.String())
} else {
obj.LabelPosition = go2.Pointer(label.InsideMiddleCenter.String())
}
if float64(obj.LabelDimensions.Width) > obj.Width ||
float64(obj.LabelDimensions.Height) > obj.Height {
if len(obj.ChildrenArray) > 0 {
obj.LabelPosition = go2.Pointer(label.OutsideTopCenter.String())
} else {
obj.LabelPosition = go2.Pointer(label.OutsideBottomCenter.String())
}
}
}
2025-02-22 10:42:02 +00:00
}