ichigo/engine/scene.go

package engine

import (
	"encoding/gob"
	"math"
	"sort"

	"github.com/hajimehoshi/ebiten/v2"
)

func init() {
	gob.Register(Scene{})
}

// Drawer components can draw themselves. Draw is called often.
type Drawer interface {
	Draw(screen *ebiten.Image, geom ebiten.GeoM)
}

// Updater components can update themselves. Update is called repeatedly.
type Updater interface {
	Update() error
}

// ZPositioner is used to reorder layers.
type ZPositioner interface {
	Z() float64
}

// Scene manages drawing and updating a bunch of components.
type Scene struct {
	Components []interface{}
	Disabled   bool
	Hidden     bool
	ID
	Transform GeoMDef
	ZPos
}

// Draw draws all components in order.
func (s *Scene) Draw(screen *ebiten.Image, geom ebiten.GeoM) {
	if s.Hidden {
		return
	}
	geom.Concat(*s.Transform.GeoM())

	for _, i := range s.Components {
		if d, ok := i.(Drawer); ok {
			d.Draw(screen, geom)
		}
	}
}

// sortByZ sorts the components by Z position.
// Stable sort is used to avoid Z-fighting among layers without a Z, or
// among those with equal Z. All non-ZPositioners are sorted first.
func (s *Scene) sortByZ() {
	sort.SliceStable(s.Components, func(i, j int) bool {
		a, aok := s.Components[i].(ZPositioner)
		b, bok := s.Components[j].(ZPositioner)
		if aok && bok {
			return a.Z() < b.Z()
		}
		return !aok && bok
	})
}

// Scan returns all immediate subcomponents.
func (s *Scene) Scan() []interface{} { return s.Components }

// Update calls Update on all Updater components.
func (s *Scene) Update() error {
	if s.Disabled {
		return nil
	}
	needsSort := false
	curZ := -math.MaxFloat64 // fun fact: this is min float64
	for _, c := range s.Components {
		// Update each updater in turn
		if u, ok := c.(Updater); ok {
			if err := u.Update(); err != nil {
				return err
			}
		}
		if !needsSort {
			// Check if the update put the components out of order
			if z, ok := c.(ZPositioner); ok {
				if t := z.Z(); t < curZ {
					needsSort = true
					curZ = t
				}
			}
		}
	}
	if needsSort {
		s.sortByZ()
	}
	return nil
}