label.go

package glmenu

import (
	"github.com/4ydx/gltext/v4.1"
	"github.com/go-gl/mathgl/mgl32"
)

type LabelAction int

const (
	NOOP LabelAction = iota
	GOTO_MENU
	EXIT_MENU
	EXIT_GAME
)

type LabelConfig struct {
	Padding Padding
	Action  LabelAction
	Goto    string
}

type LabelInteraction func(
	xPos, yPos float64,
	button MouseClick,
	isInBoundingBox bool,
)

type Label struct {
	Config  LabelConfig
	Menu    *Menu
	Text    *v41.Text
	IsHover bool
	IsClick bool

	// public methods are expected to be defined by the user and run before the private method are called
	// if a public method is undefined, it is skipped.  Currently I have only defined onRelease as private.
	OnClick       LabelInteraction
	onRelease     LabelInteraction // set internally.  handles linking different menus together, closing menus, closing game etc.
	StopOnRelease bool             // set to true in order to prevent onRelease being called
	OnRelease     LabelInteraction
	OnHover       LabelInteraction
	OnNotHover    func()
}

func (label *Label) Reset() {
	label.Text.SetScale(label.Text.ScaleMin)
}

func (label *Label) GetPosition() mgl32.Vec2 {
	return label.Text.Position
}

func (label *Label) GetPadding() Padding {
	return label.Config.Padding
}

func (label *Label) SetString(str string, argv ...interface{}) {
	if len(argv) == 0 {
		label.Text.SetString(str)
	} else {
		label.Text.SetString(str, argv...)
	}
}

func (label *Label) OrthoToScreenCoord() (X1 Point, X2 Point) {
	if label.Menu != nil && label.Text != nil {
		x1, x2 := label.Text.GetBoundingBox()
		X1.X = x1.X + label.Menu.WindowWidth/2
		X1.Y = x1.Y + label.Menu.WindowHeight/2

		X2.X = x2.X + label.Menu.WindowWidth/2
		X2.Y = x2.Y + label.Menu.WindowHeight/2
	} else {
		if label.Menu == nil {
			MenuDebug("Uninitialized Menu Object")
		}
		if label.Text == nil {
			MenuDebug("Uninitialized Text Object")
		}
	}
	return
}

// IsClicked uses a bounding box to determine clicks
func (label *Label) IsClicked(xPos, yPos float64, button MouseClick) {
	// menu rendering (and text) is positioned in orthographic projection coordinates
	// but click positions are based on window coordinates
	// we have to transform them
	X1, X2 := label.OrthoToScreenCoord()
	inBox := float32(xPos) > X1.X && float32(xPos) < X2.X && float32(yPos) > X1.Y && float32(yPos) < X2.Y
	if inBox {
		label.IsClick = true
		if label.OnClick != nil {
			label.OnClick(xPos, yPos, button, inBox)
		}
	}
}

// InsidePoint returns a point nearby the center of the label
// Used to locate a screen position where clicking can be simulated
func (label *Label) InsidePoint() (P Point) {
	X1, X2 := label.OrthoToScreenCoord()
	P.X = (X2.X-X1.X)/2 + X1.X
	P.Y = (X2.Y-X1.Y)/2 + X1.Y
	return
}

// IsReleased is checked for all labels in a menu when mouseup occurs
func (label *Label) IsReleased(xPos, yPos float64, button MouseClick) {
	// anything flagged as clicked now needs to decide whether to execute its logic based on inBox
	X1, X2 := label.OrthoToScreenCoord()
	inBox := float32(xPos) > X1.X && float32(xPos) < X2.X && float32(yPos) > X1.Y && float32(yPos) < X2.Y
	if label.IsClick {
		if label.IsHover {
			label.Text.SetColor(label.Menu.Defaults.TextHover)
		} else {
			label.Text.SetColor(label.Menu.Defaults.TextColor)
		}
		if label.OnRelease != nil {
			label.OnRelease(xPos, yPos, button, inBox)
		}
		if !label.StopOnRelease {
			label.onRelease(xPos, yPos, button, inBox)
		}
		label.StopOnRelease = false
	}
	label.IsClick = false
}

// IsHovered uses a bounding box
func (label *Label) IsHovered(xPos, yPos float64) {
	X1, X2 := label.OrthoToScreenCoord()
	inBox := float32(xPos) > X1.X && float32(xPos) < X2.X && float32(yPos) > X1.Y && float32(yPos) < X2.Y
	label.IsHover = inBox
	if inBox {
		label.OnHover(xPos, yPos, MouseUnclicked, inBox)
	}
}

func (label *Label) Draw() {
	label.Text.Draw()
}

func (label *Label) SetPosition(v mgl32.Vec2) {
	label.Text.SetPosition(v)
}

func (label *Label) Height() float32 {
	return label.Text.Height()
}

func (label *Label) Width() float32 {
	return label.Text.Width()
}

func (label *Label) NavigateTo() {
	point := label.InsidePoint()
	if label.OnHover != nil {
		label.IsHovered(float64(point.X), float64(point.Y))
	}
}

// NavigateAway if we end up needing to navigate away from this item then let the caller know
// because it might need that information.  return value of 'true'
func (label *Label) NavigateAway() bool {
	if label.IsHover {
		label.IsHover = false
		return true
	}
	return false
}

func (label *Label) Follow() bool {
	if label.IsHover {
		point := label.InsidePoint()
		label.IsClicked(float64(point.X), float64(point.Y), MouseLeft)
		label.IsReleased(float64(point.X), float64(point.Y), MouseLeft)
		return true
	}
	return false
}

func (label *Label) IsNoop() bool {
	return label.Config.Action == NOOP
}

func (label *Label) Type() FormatableType {
	return FormatableLabel
}