update API + refactoring

Author: setanarut

anim.go

@@ -2,12 +2,28 @@ package anim
 
 import (
 	"fmt"
-	"image"
 	"math"
 
 	"github.com/hajimehoshi/ebiten/v2"
 )
 
+const str string = `
+Playback state;
+Current Atlas: %v
+Current Anim: %v
+Paused: %v
+Tick: %v
+Current Anim Index %v
+Current Anim FPS: %v
+`
+
+// Animation for AnimationPlayer
+type Animation struct {
+	Name   string          // Name of the aimation state
+	Frames []*ebiten.Image // Animation frames
+	FPS    float64         // Animation playback speed (Frames Per Second).
+}
+
 // PlaybackData is AnimationPlayer's playback data.
 // With this structure, the playback state can be saved to disk and reloaded.
 type PlaybackData struct {
@@ -23,16 +39,6 @@ type PlaybackData struct {
 	CurrentIndex int
 }
 
-var str = `
-Playback state;
-Current Atlas: %v
-Current Anim: %v
-Paused: %v
-Tick: %v
-Current Anim Index %v
-Current Anim FPS: %v
-`
-
 // AnimationPlayer plays and manages animations.
 type AnimationPlayer struct {
 	Data *PlaybackData
@@ -45,15 +51,15 @@ type AnimationPlayer struct {
 	Animations map[string]map[string]*Animation
 }
 
-func (a *AnimationPlayer) String() string {
+func (ap *AnimationPlayer) String() string {
 	return fmt.Sprintf(
 		str,
-		a.Data.CurrentAtlas,
-		a.Data.CurrentAnim,
-		a.Data.Paused,
-		a.Data.Tick,
-		a.Data.CurrentIndex,
-		a.CurrentAnimFPS(),
+		ap.Data.CurrentAtlas,
+		ap.Data.CurrentAnim,
+		ap.Data.Paused,
+		ap.Data.Tick,
+		ap.Data.CurrentIndex,
+		ap.CurrentAnimFPS(),
 	)
 }
 
@@ -105,7 +111,12 @@ func (ap *AnimationPlayer) NewAnim(
 		if pingPong {
 			subImages = MakePingPong(subImages)
 		}
-		animation := NewAnimation(stateName, subImages, FPS)
+		// animation := NewAnimation(stateName, subImages, FPS)
+		animation := &Animation{
+			Name:   stateName,
+			Frames: subImages,
+			FPS:    FPS,
+		}
 		ap.Animations[atlas.Name][stateName] = animation
 	}
 	ap.Data.CurrentAnim = stateName
@@ -122,12 +133,6 @@ func (ap *AnimationPlayer) SetAllFPS(FPS float64) {
 	}
 }
 
-// AddAnimation adds the given animation to this player.
-// Adds the name of the animation as a map key.
-func (ap *AnimationPlayer) AddAnimation(a *Animation) {
-	ap.Animations[ap.Data.CurrentAtlas][a.Name] = a
-}
-
 // CurrentAnimFPS returns FPS of the current animation
 func (ap *AnimationPlayer) CurrentAnimFPS() float64 {
 	return ap.Animations[ap.Data.CurrentAtlas][ap.Data.CurrentAnim].FPS
@@ -141,18 +146,25 @@ func (ap *AnimationPlayer) SetAnimFPS(animName string, FPS float64) {
 // SetAnim sets the animation and resets to the first frame.
 //
 // If you assign ap.Data.CurrentAnim = "animName" directly, the animation will not be reset.
-func (ap *AnimationPlayer) SetAnim(state string) {
-	if ap.Data.CurrentAnim != state {
-		ap.Data.CurrentAnim = state
+func (ap *AnimationPlayer) SetAnim(animName string) {
+	if ap.Data.CurrentAnim != animName {
+		ap.Data.CurrentAnim = animName
 		ap.Data.Tick = 0
 		ap.Data.CurrentIndex = 0
 	}
 }
 
-func (ap *AnimationPlayer) CurrentAtlas() string {
+func (ap *AnimationPlayer) SetAtlas(atlasName string) {
+	ap.Data.CurrentAtlas = atlasName
+}
+
+// Atlas returns current Atlas
+func (ap *AnimationPlayer) Atlas() string {
 	return ap.Data.CurrentAtlas
 }
-func (ap *AnimationPlayer) CurrentAnim() string {
+
+// Anim returns current animation state name
+func (ap *AnimationPlayer) Anim() string {
 	return ap.Data.CurrentAnim
 }
 
@@ -182,48 +194,3 @@ func (ap *AnimationPlayer) Update() {
 	// update current frame
 	ap.CurrentFrame = ap.Animations[ap.Data.CurrentAtlas][ap.Data.CurrentAnim].Frames[ap.Data.CurrentIndex]
 }
-
-// Animation for AnimationPlayer
-type Animation struct {
-	Name   string          // Name of the aimation state
-	Frames []*ebiten.Image // Animation frames
-	FPS    float64         // Animation playback speed (Frames Per Second).
-}
-
-// NewAnimation returns new Animation
-func NewAnimation(name string, frames []*ebiten.Image, FPS float64) *Animation {
-	return &Animation{
-		Name:   name,
-		Frames: frames,
-		FPS:    FPS,
-	}
-}
-
-// SubImages returns sub-images from spriteSheet image
-func SubImages(spriteSheet *ebiten.Image, x, y, w, h, subImageCount int, vertical bool) []*ebiten.Image {
-
-	subImages := []*ebiten.Image{}
-	frameRect := image.Rect(x, y, x+w, y+h)
-
-	for range subImageCount {
-		subImages = append(subImages, spriteSheet.SubImage(frameRect).(*ebiten.Image))
-		if vertical {
-			frameRect.Min.Y += h
-			frameRect.Max.Y += h
-		} else {
-			frameRect.Min.X += w
-			frameRect.Max.X += w
-		}
-	}
-	return subImages
-
-}
-
-// MakePingPong arranges the animation indexes to play back and forth.
-// [0 1 2 3] -> [0 1 2 3 2 1]
-func MakePingPong(frames []*ebiten.Image) []*ebiten.Image {
-	for i := len(frames) - 2; i > 0; i-- {
-		frames = append(frames, frames[i])
-	}
-	return frames
-}

examples/atlases/main.go

@@ -38,11 +38,11 @@ func (g *Game) Update() error {
 	DIO.GeoM.Reset()
 
 	if inpututil.IsKeyJustPressed(ebiten.KeyF) {
-		switch animPlayer.CurrentAtlas() {
+		switch animPlayer.Atlas() {
 		case "ShiftHue":
-			animPlayer.Data.CurrentAtlas = "Default"
+			animPlayer.SetAtlas("Default")
 		case "Default":
-			animPlayer.Data.CurrentAtlas = "ShiftHue"
+			animPlayer.SetAtlas("ShiftHue")
 		}
 	}
 

examples/demo/main.go

@@ -77,7 +77,7 @@ func main() {
 	animPlayer.NewAnim("idle", 0, 0, 32, 32, 5, false, false, 5)
 	animPlayer.NewAnim("run", 0, 32, 32, 32, 8, false, false, 12)
 	animPlayer.NewAnim("jump", 0, 32*2, 32, 32, 4, false, false, 15)
-	animPlayer.Data.CurrentAnim = "idle"
+	animPlayer.SetAnim("idle")
 
 	ebiten.SetWindowSize(400, 300)
 	if err := ebiten.RunGame(&Game{}); err != nil {

helper.go

@@ -0,0 +1,36 @@
+package anim
+
+import (
+	"image"
+
+	"github.com/hajimehoshi/ebiten/v2"
+)
+
+// SubImages returns sub-images from spriteSheet image
+func SubImages(spriteSheet *ebiten.Image, x, y, w, h, subImageCount int, vertical bool) []*ebiten.Image {
+
+	subImages := []*ebiten.Image{}
+	frameRect := image.Rect(x, y, x+w, y+h)
+
+	for range subImageCount {
+		subImages = append(subImages, spriteSheet.SubImage(frameRect).(*ebiten.Image))
+		if vertical {
+			frameRect.Min.Y += h
+			frameRect.Max.Y += h
+		} else {
+			frameRect.Min.X += w
+			frameRect.Max.X += w
+		}
+	}
+	return subImages
+
+}
+
+// MakePingPong arranges the animation indexes to play back and forth.
+// [0 1 2 3] -> [0 1 2 3 2 1]
+func MakePingPong(frames []*ebiten.Image) []*ebiten.Image {
+	for i := len(frames) - 2; i > 0; i-- {
+		frames = append(frames, frames[i])
+	}
+	return frames
+}