geom

Documentation

Overview

Package geom provides geometry primitives.

Index

• func PointSegmentDistance(s1, s2, p Point) float64
• func PointSegmentDistanceSquared(s1, s2, p Point) float64
• type Insets
  • func NewHorizontalInsets(amount float64) Insets
  • func NewUniformInsets(amount float64) Insets
  • func NewVerticalInsets(amount float64) Insets
  • func (i *Insets) Add(insets Insets) *Insets
  • func (i Insets) String() string
  • func (i *Insets) Subtract(insets Insets) *Insets
• type Point
  • func LineIntersection(a1, a2, b1, b2 Point) []Point
  • func NewPoint(x, y float64) Point
  • func NewPointPtr(x, y float64) *Point
  • func (p *Point) Add(pt Point) *Point
  • func (p *Point) Align() *Point
  • func (p Point) String() string
  • func (p *Point) Subtract(pt Point) *Point
• type Rect
  • func NewRect(x, y, width, height float64) Rect
  • func NewRectPtr(x, y, width, height float64) *Rect
  • func (r *Rect) Align() *Rect
  • func (r Rect) Bottom() float64
  • func (r Rect) BottomLeft() Point
  • func (r Rect) BottomRight() Point
  • func (r Rect) Center() Point
  • func (r Rect) CenterX() float64
  • func (r Rect) CenterY() float64
  • func (r Rect) ContainsPoint(pt Point) bool
  • func (r Rect) ContainsRect(in Rect) bool
  • func (r *Rect) CopyAndZeroLocation() Rect
  • func (r *Rect) Inset(insets Insets) *Rect
  • func (r *Rect) InsetUniform(amount float64) *Rect
  • func (r *Rect) Intersect(other Rect) *Rect
  • func (r Rect) Intersects(other Rect) bool
  • func (r Rect) IntersectsLine(start, end Point) bool
  • func (r Rect) IsEmpty() bool
  • func (r Rect) Max() Point
  • func (r Rect) Right() float64
  • func (r Rect) String() string
  • func (r Rect) TopLeft() Point
  • func (r Rect) TopRight() Point
  • func (r *Rect) Union(other Rect) *Rect
• type Size
  • func NewSize(width, height float64) Size
  • func NewSizePtr(x, y float64) *Size
  • func (s *Size) Add(size Size) *Size
  • func (s *Size) AddInsets(insets Insets) *Size
  • func (s *Size) ConstrainForHint(hint Size) *Size
  • func (s *Size) GrowToInteger() *Size
  • func (s *Size) Max(other Size) *Size
  • func (s *Size) Min(other Size) *Size
  • func (s Size) String() string
  • func (s *Size) Subtract(size Size) *Size
  • func (s *Size) SubtractInsets(insets Insets) *Size

Functions

func PointSegmentDistance

func PointSegmentDistance(s1, s2, p Point) float64

PointSegmentDistance returns the distance from a point to a line segment. The distance measured is the distance between the specified point and the closest point between the specified end points. If the specified point intersects the line segment in between the end points, this function returns 0.

func PointSegmentDistanceSquared

func PointSegmentDistanceSquared(s1, s2, p Point) float64

PointSegmentDistanceSquared returns the square of the distance from a point to a line segment. The distance measured is the distance between the specified point and the closest point between the specified end points. If the specified point intersects the line segment in between the end points, this function returns 0.

Types

type Insets

type Insets struct {
	Top    float64
	Left   float64
	Bottom float64
	Right  float64
}

Insets defines margins on each side of a rectangle.

func NewHorizontalInsets

func NewHorizontalInsets(amount float64) Insets

NewHorizontalInsets creates a new Insets whose left and right edges have the specified value.

func NewUniformInsets

func NewUniformInsets(amount float64) Insets

NewUniformInsets creates a new Insets whose edges all have the same value.

func NewVerticalInsets

func NewVerticalInsets(amount float64) Insets

NewVerticalInsets creates a new Insets whose top and bottom edges have the specified value.

func (*Insets) Add

func (i *Insets) Add(insets Insets) *Insets

Add modifies this Insets by adding the supplied Insets. Returns itself for easy chaining.

func (Insets) String

func (i Insets) String() string

String implements the fmt.Stringer interface.

func (*Insets) Subtract

func (i *Insets) Subtract(insets Insets) *Insets

Subtract modifies this Insets by subtracting the supplied Insets. Returns itself for easy chaining.

type Point

type Point struct {
	X, Y float64
}

Point defines a location.

func LineIntersection

func LineIntersection(a1, a2, b1, b2 Point) []Point

LineIntersection determines the intersection of two lines, if any. A return of no points indicates no intersection. One point indicates intersection at a single point. Two points indicates an overlapping line segment.

func NewPoint

func NewPoint(x, y float64) Point

NewPoint creates a new Point.

func NewPointPtr

func NewPointPtr(x, y float64) *Point

NewPointPtr creates a new *Point.

func (*Point) Add

func (p *Point) Add(pt Point) *Point

Add modifies this Point by adding the supplied coordinates. Returns itself for easy chaining.

func (*Point) Align

func (p *Point) Align() *Point

Align modifies this Point to align with integer coordinates. Returns itself for easy chaining.

func (Point) String

func (p Point) String() string

String implements the fmt.Stringer interface.

func (*Point) Subtract

func (p *Point) Subtract(pt Point) *Point

Subtract modifies this Point by subtracting the supplied coordinates. Returns itself for easy chaining.

type Rect

type Rect struct {
	Point
	Size
}

Rect defines a rectangle.

func NewRect

func NewRect(x, y, width, height float64) Rect

NewRect creates a new Rect.

func NewRectPtr

func NewRectPtr(x, y, width, height float64) *Rect

NewRectPtr creates a new *Rect.

func (*Rect) Align

func (r *Rect) Align() *Rect

Align modifies this rectangle to align with integer coordinates that would encompass the original rectangle. Returns itself for easy chaining.

func (Rect) Bottom

func (r Rect) Bottom() float64

Bottom returns the bottom edge, or Y + Height.

func (Rect) BottomLeft

func (r Rect) BottomLeft() Point

BottomLeft returns the bottom-left point of the rectangle.

func (Rect) BottomRight

func (r Rect) BottomRight() Point

BottomRight returns the bottom-right point of the rectangle.

func (Rect) Center

func (r Rect) Center() Point

Center returns the center of the rectangle.

func (Rect) CenterX

func (r Rect) CenterX() float64

CenterX returns the center x-coordinate of the rectangle.

func (Rect) CenterY

func (r Rect) CenterY() float64

CenterY returns the center y-coordinate of the rectangle.

func (Rect) ContainsPoint

func (r Rect) ContainsPoint(pt Point) bool

ContainsPoint returns true if the coordinates are within the Rect.

func (Rect) ContainsRect

func (r Rect) ContainsRect(in Rect) bool

ContainsRect returns true if this Rect fully contains the passed in Rect.

func (*Rect) CopyAndZeroLocation

func (r *Rect) CopyAndZeroLocation() Rect

CopyAndZeroLocation creates a new copy of the Rect and sets the location of the copy to 0,0.

func (*Rect) Inset

func (r *Rect) Inset(insets Insets) *Rect

Inset this Rect by the specified Insets. Returns itself for easy chaining.

func (*Rect) InsetUniform

func (r *Rect) InsetUniform(amount float64) *Rect

InsetUniform insets this Rect by the specified amount on all sides. Positive values make the Rect smaller, while negative values make it larger. Returns itself for easy chaining.

func (*Rect) Intersect

func (r *Rect) Intersect(other Rect) *Rect

Intersect this Rect with another Rect, storing the result into this Rect. Returns itself for easy chaining.

func (Rect) Intersects

func (r Rect) Intersects(other Rect) bool

Intersects returns true if this rect and the other rect intersect.

func (Rect) IntersectsLine

func (r Rect) IntersectsLine(start, end Point) bool

IntersectsLine returns true if this rect and the line described by start and end intersect.

func (Rect) IsEmpty

func (r Rect) IsEmpty() bool

IsEmpty returns true if either the width or height is zero or less.

func (Rect) Max

func (r Rect) Max() Point

Max returns the bottom right corner of the rectangle.

func (Rect) Right

func (r Rect) Right() float64

Right returns the right edge, or X + Width.

func (Rect) String

func (r Rect) String() string

String implements the fmt.Stringer interface.

func (Rect) TopLeft

func (r Rect) TopLeft() Point

TopLeft returns the top-left point of the rectangle.

func (Rect) TopRight

func (r Rect) TopRight() Point

TopRight returns the top-right point of the rectangle.

func (*Rect) Union

func (r *Rect) Union(other Rect) *Rect

Union this Rect with another Rect, storing the result into this Rect. Returns itself for easy chaining.

type Size

type Size struct {
	Width, Height float64
}

Size defines a width and height.

func NewSize

func NewSize(width, height float64) Size

NewSize creates a new Size.

func NewSizePtr

func NewSizePtr(x, y float64) *Size

NewSizePtr creates a new *Size.

func (*Size) Add

func (s *Size) Add(size Size) *Size

Add modifies this Size by adding the supplied Size. Returns itself for easy chaining.

func (*Size) AddInsets

func (s *Size) AddInsets(insets Insets) *Size

AddInsets modifies this Size by expanding it to accommodate the specified insets. Returns itself for easy chaining.

func (*Size) ConstrainForHint

func (s *Size) ConstrainForHint(hint Size) *Size

ConstrainForHint ensures this size is no larger than the hint. Hint values less than one are ignored. Returns itself for easy chaining.

func (*Size) GrowToInteger

func (s *Size) GrowToInteger() *Size

GrowToInteger modifies this Size such that its width and height are both the smallest integers greater than or equal to their original values. Returns itself for easy chaining.

func (*Size) Max

func (s *Size) Max(other Size) *Size

Max modifies this Size to contain the largest values between itself and 'other'. Returns itself for easy chaining.

func (*Size) Min

func (s *Size) Min(other Size) *Size

Min modifies this Size to contain the smallest values between itself and 'other'. Returns itself for easy chaining.

func (Size) String

func (s Size) String() string

String implements the fmt.Stringer interface.

func (*Size) Subtract

func (s *Size) Subtract(size Size) *Size

Subtract modifies this Size by subtracting the supplied Size. Returns itself for easy chaining.

func (*Size) SubtractInsets

func (s *Size) SubtractInsets(insets Insets) *Size

SubtractInsets modifies this Size by reducing it to accommodate the specified insets. Returns itself for easy chaining.