// Copyright 2018 The Ebiten Authors // // 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. // Package packing offers a packing algorithm in 2D space. package packing import ( "errors" "fmt" ) const ( minSize = 1 ) type Page struct { root *Node width int height int maxSize int } func isPositivePowerOf2(x int) bool { if x <= 0 { return false } for x > 1 { if x/2*2 != x { return false } x /= 2 } return true } func NewPage(initSize int, maxSize int) *Page { if !isPositivePowerOf2(initSize) { panic(fmt.Sprintf("packing: initSize must be a positive power of 2 but %d", initSize)) } if !isPositivePowerOf2(maxSize) { panic(fmt.Sprintf("packing: maxSize must be a positive power of 2 but %d", maxSize)) } return &Page{ width: initSize, height: initSize, maxSize: maxSize, } } func (p *Page) IsEmpty() bool { if p.root == nil { return true } return !p.root.used && p.root.child0 == nil && p.root.child1 == nil } type Node struct { x int y int width int height int used bool parent *Node child0 *Node child1 *Node } func (n *Node) canFree() bool { if n.used { return false } if n.child0 == nil && n.child1 == nil { return true } return n.child0.canFree() && n.child1.canFree() } func (n *Node) Region() (x, y, width, height int) { return n.x, n.y, n.width, n.height } // square returns a float value indicating how much the given rectangle is close to a square. // If the given rectangle is square, this return 1 (maximum value). // Otherwise, this returns a value in [0, 1). func square(width, height int) float64 { if width == 0 && height == 0 { return 0 } if width <= height { return float64(width) / float64(height) } return float64(height) / float64(width) } func (p *Page) canAlloc(n *Node, width, height int) bool { if p.root == nil { return p.width >= width && p.height >= height } return canAlloc(p.root, width, height) } func canAlloc(n *Node, width, height int) bool { if n.width < width || n.height < height { return false } if n.used { return false } if n.child0 == nil && n.child1 == nil { return true } if canAlloc(n.child0, width, height) { return true } if canAlloc(n.child1, width, height) { return true } return false } func alloc(n *Node, width, height int) *Node { if n.width < width || n.height < height { return nil } if n.used { return nil } if n.child0 == nil && n.child1 == nil { if n.width == width && n.height == height { n.used = true return n } if square(n.width-width, n.height) >= square(n.width, n.height-height) { // Split vertically n.child0 = &Node{ x: n.x, y: n.y, width: width, height: n.height, parent: n, } n.child1 = &Node{ x: n.x + width, y: n.y, width: n.width - width, height: n.height, parent: n, } } else { // Split horizontally n.child0 = &Node{ x: n.x, y: n.y, width: n.width, height: height, parent: n, } n.child1 = &Node{ x: n.x, y: n.y + height, width: n.width, height: n.height - height, parent: n, } } return alloc(n.child0, width, height) } if n.child0 == nil || n.child1 == nil { panic("packing: both two children must not be nil at alloc") } if node := alloc(n.child0, width, height); node != nil { return node } if node := alloc(n.child1, width, height); node != nil { return node } return nil } func (p *Page) Size() (int, int) { return p.width, p.height } func (p *Page) Alloc(width, height int) *Node { if width <= 0 || height <= 0 { panic("packing: width and height must > 0") } if !p.extendFor(width, height) { return nil } if p.root == nil { p.root = &Node{ width: p.width, height: p.height, } } if width < minSize { width = minSize } if height < minSize { height = minSize } return alloc(p.root, width, height) } func (p *Page) Free(node *Node) { if node.child0 != nil || node.child1 != nil { panic("packing: can't free the node including children") } node.used = false if node.parent == nil { return } if node.parent.child0 == nil || node.parent.child1 == nil { panic("packing: both two children must not be nil at Free: double free happened?") } if node.parent.child0.canFree() && node.parent.child1.canFree() { node.parent.child0 = nil node.parent.child1 = nil p.Free(node.parent) } } func walk(n *Node, f func(n *Node) error) error { if err := f(n); err != nil { return err } if n.child0 != nil { if err := walk(n.child0, f); err != nil { return err } } if n.child1 != nil { if err := walk(n.child1, f); err != nil { return err } } return nil } func (p *Page) extendFor(width, height int) bool { if p.canAlloc(p.root, width, height) { return true } if p.width >= p.maxSize && p.height >= p.maxSize { return false } // (1, 0), (0, 1), (2, 0), (1, 1), (0, 2), (3, 0), (2, 1), (1, 2), (0, 3), ... for i := 1; ; i++ { for j := 0; j <= i; j++ { newWidth := p.width for k := 0; k < i-j; k++ { newWidth *= 2 } newHeight := p.height for k := 0; k < j; k++ { newHeight *= 2 } if newWidth > p.maxSize || newHeight > p.maxSize { if newWidth > p.maxSize && newHeight > p.maxSize { panic(fmt.Sprintf("packing: too big extension: allocating size: (%d, %d), current size: (%d, %d), new size: (%d, %d), (i, j): (%d, %d), max size: %d", width, height, p.width, p.height, newWidth, newHeight, i, j, p.maxSize)) } continue } rollback := p.extend(newWidth, newHeight) if p.canAlloc(p.root, width, height) { return true } rollback() // If the allocation failed even with a maximized page, give up the allocation. if newWidth >= p.maxSize && newHeight >= p.maxSize { return false } } } } func (p *Page) extend(newWidth int, newHeight int) func() { edgeNodes := []*Node{} abort := errors.New("abort") aborted := false if p.root != nil { _ = walk(p.root, func(n *Node) error { if n.x+n.width < p.width && n.y+n.height < p.height { return nil } if n.used { aborted = true return abort } edgeNodes = append(edgeNodes, n) return nil }) } var rollback func() if aborted { origRoot := *p.root // Extend the page in the vertical direction. if newHeight-p.height > 0 { upper := p.root lower := &Node{ x: 0, y: p.height, width: p.width, height: newHeight - p.height, } p.root = &Node{ x: 0, y: 0, width: p.width, height: newHeight, child0: upper, child1: lower, } upper.parent = p.root lower.parent = p.root } // Extend the page in the horizontal direction. if newWidth-p.width > 0 { left := p.root right := &Node{ x: p.width, y: 0, width: newWidth - p.width, height: newHeight, } p.root = &Node{ x: 0, y: 0, width: newWidth, height: newHeight, child0: left, child1: right, } left.parent = p.root right.parent = p.root } origWidth, origHeight := p.width, p.height rollback = func() { p.width = origWidth p.height = origHeight p.root = &origRoot } } else { origWidth, origHeight := p.width, p.height origWidths := map[*Node]int{} origHeights := map[*Node]int{} for _, n := range edgeNodes { if n.x+n.width == p.width { origWidths[n] = n.width n.width += newWidth - p.width } if n.y+n.height == p.height { origHeights[n] = n.height n.height += newHeight - p.height } } rollback = func() { p.width = origWidth p.height = origHeight for n, w := range origWidths { n.width = w } for n, h := range origHeights { n.height = h } } } p.width = newWidth p.height = newHeight return rollback }