geom

README

geom

Package geom provides a range of geometric primitives and convenience methods. Notably, it contains:

• Data types for representing static bitmaps of terminal data (image.Image) and terminal state (tty.State).
• Vec2, a traditional vector data type but with a terminal flavor: ie it uses R and C (for rows and columns) instead of X and Y

Documentation

Index

• Variables
• func Abs(value int) int
• func AsUint16(val int) uint16
• func Clamp(value, min, max int) int
• func Max(first int, second int) int
• func Max16(first int16, second int16) int16
• func Max32(first int32, second int32) int32
• func Min(first int, second int) int
• type Rect
  • func (r Rect) BottomRight() Vec2
  • func (r Rect) Contains(v Vec2) bool
• type Size
• type Vec2
  • func GetMaximum(a, b Vec2) Vec2
  • func NormalizeRange(start, end Vec2) (newStart, newEnd Vec2)
  • func (v Vec2) Add(other Vec2) Vec2
  • func (v Vec2) Center(other Vec2) Vec2
  • func (v Vec2) Clamp(min, max Vec2) Vec2
  • func (v Vec2) GT(other Vec2) bool
  • func (v Vec2) GTE(other Vec2) bool
  • func (v Vec2) IsZero() bool
  • func (v Vec2) LT(other Vec2) bool
  • func (v Vec2) LTE(other Vec2) bool
  • func (v Vec2) Scalar(value int) Vec2
  • func (v Vec2) Sub(other Vec2) Vec2

Variables

var DEFAULT_SIZE = Vec2{
	R: 24,
	C: 80,
}

var UnitVec2 = Vec2{R: 1, C: 1}

Functions

func Abs

func Abs(value int) int

Abs returns the absolute value of an integer.

func AsUint16

func AsUint16(val int) uint16

func Clamp

func Clamp(value, min, max int) int

func Max

func Max(first int, second int) int

Max returns the largest integer

func Max16

func Max16(first int16, second int16) int16

Max16 returns the largest integer

func Max32

func Max32(first int32, second int32) int32

Max32 returns the largest 32-bit integer

func Min

func Min(first int, second int) int

Min returns the smallest integer

Types

type Rect

type Rect struct {
	Position, Size Vec2
}

func (Rect) BottomRight

func (r Rect) BottomRight() Vec2

Get the position of the bottom-right corner of the Rect.

func (Rect) Contains

func (r Rect) Contains(v Vec2) bool

type Size

type Size = Vec2

type Vec2

type Vec2 struct {

	// row (y)
	R int
	// column (x)
	C int
	// contains filtered or unexported fields
}

func GetMaximum

func GetMaximum(a, b Vec2) Vec2

Find the largest rectangle that both rectangle `a` and `b` can fit.

func NormalizeRange

func NormalizeRange(start, end Vec2) (newStart, newEnd Vec2)

func (Vec2) Add

func (v Vec2) Add(other Vec2) Vec2

func (Vec2) Center

func (v Vec2) Center(other Vec2) Vec2

Calculate the position that centers the rectangle described by `other` inside of the rectangle described by `v`.

func (Vec2) Clamp

func (v Vec2) Clamp(min, max Vec2) Vec2

func (Vec2) GT

func (v Vec2) GT(other Vec2) bool

func (Vec2) GTE

func (v Vec2) GTE(other Vec2) bool

func (Vec2) IsZero

func (v Vec2) IsZero() bool

func (Vec2) LT

func (v Vec2) LT(other Vec2) bool

func (Vec2) LTE

func (v Vec2) LTE(other Vec2) bool

func (Vec2) Scalar

func (v Vec2) Scalar(value int) Vec2

func (Vec2) Sub

func (v Vec2) Sub(other Vec2) Vec2