ui

Documentation

Overview

Package ui contains the components for displaying ui elements

Index

• Constants
• Variables
• type ButtonColor
• type ButtonHoverColors
• type FlatButton
• type HAlignment
• type SpriteButton
• type Text
• type VAlignment

Constants

const (
	LeftHAlignment   = HAlignment(iota) // LeftHAlignment indicates left Text HAlignment
	RightHAlignment                     // RightHAlignment indicates right Text HAlignment
	CenterHAlignment                    // RightHAlignment indicates center Text HAlignment
)

Horizontal Text alignments

const (
	BottomVAlignment = VAlignment(iota) // BottomVAlignment indicates bottom text.VAlignment
	TopVAlignment                       // TopVAlignment indicates top text.VAlignment
	MiddleVAlignment                    // MiddleVAlignment indicates middle text.VAlignment
)

Vertical Text alignments

Variables

var Get = gets{

	FlatButton: func(e *entity.Entity) FlatButton {
		return e.Get(TYPE.FlatButton).(FlatButton)
	},

	ButtonHoverColors: func(e *entity.Entity) ButtonHoverColors {
		return e.Get(TYPE.ButtonHoverColors).(ButtonHoverColors)
	},

	SpriteButton: func(e *entity.Entity) SpriteButton {
		return e.Get(TYPE.SpriteButton).(SpriteButton)
	},

	Text: func(e *entity.Entity) Text {
		return e.Get(TYPE.Text).(Text)
	},
}

Get a ui component

var TYPE = types{
	FlatButton:        reflect.TypeOf(FlatButton{}),
	ButtonHoverColors: reflect.TypeOf(ButtonHoverColors{}),
	SpriteButton:      reflect.TypeOf(SpriteButton{}),
	Text:              reflect.TypeOf(Text{}),
}

TYPE hold the reflect.Type for our ui components

Types

type ButtonColor

type ButtonColor struct {
	Solid    color.Solid    // Solid is a color.Solid
	Gradient color.Gradient // Gradient is a color.Gradient
}

ButtonColor represent the colors of the button

type ButtonHoverColors

type ButtonHoverColors struct {
	Normal ButtonColor // Normal is the ui.ButtonColor on normal state
	Hover  ButtonColor // Hover is the  ui.ButtonColor on hover state
}

ButtonHoverColors is the hover colors for a FlatButton

type FlatButton

type FlatButton struct {
	Shadow geometry.Size // Shadow is the offset of the shadow on the ui.FlatButton
	Event  interface{}   // Event is the event that will be trigger when this button is click
}

FlatButton is a UI element for displaying a button

type HAlignment

type HAlignment int

HAlignment horizontal alignment for a Text

type SpriteButton

type SpriteButton struct {
	Sheet  string      // Sheet is the Sprite sheet
	Normal string      // Normal is the sprite on normal state
	Hover  string      // Hover is the  sprite on hover state
	Scale  float32     // Scale is the Sprite scale
	Sound  string      // Sound is the click sound for this SpriteButton
	Event  interface{} // Event is the event that will be trigger when this button is click
}

SpriteButton is a UI element for displaying a image base button

type Text

type Text struct {
	String     string     // String is the Text string
	Size       float32    // Size is the Text size
	Font       string     // Font is the font to use
	VAlignment VAlignment // VAlignment is the text.VAlignment
	HAlignment HAlignment // HAlignment is the text.HAlignment
}

Text is a graphical text to drawn on the screen

type VAlignment

type VAlignment int

VAlignment vertical alignment for a Text