subject

Documentation

Index

• Variables
• type Pair
  • func (p *Pair) AsLine() maths.Line
  • func (p *Pair) GoString() string
  • func (p *Pair) Next() *Pair
  • func (p *Pair) Pt1() *list.Pt
  • func (p *Pair) Pt2() *list.Pt
  • func (p *Pair) PushInBetween(e list.ElementerPointer) bool
• type Subject
  • func New(coords []float64) (*Subject, error)
  • func (s *Subject) Contains(pt maths.Pt) bool
  • func (s *Subject) DebugStringAugmented(augmenter func(idx int, e maths.Pt) string) string
  • func (s *Subject) FirstPair() *Pair
  • func (s *Subject) GetPair(idx int) *Pair
  • func (s *Subject) GoString() string
  • func (s *Subject) Init(coords []float64) (*Subject, error)
  • func (s *Subject) Winding() maths.WindingOrder

Variables

var ErrInvalidCoordsNumber = errors.New("Event number of coords expected.")

ErrInvalidCoordsNumber is the error produced when the number of coordinates provided is not even or large enough to from a linestring.

Types

type Pair

type Pair struct {
	// contains filtered or unexported fields
}

func (*Pair) AsLine

func (p *Pair) AsLine() maths.Line

func (*Pair) GoString

func (p *Pair) GoString() string

func (*Pair) Next

func (p *Pair) Next() *Pair

func (*Pair) Pt1

func (p *Pair) Pt1() *list.Pt

func (*Pair) Pt2

func (p *Pair) Pt2() *list.Pt

func (*Pair) PushInBetween

func (p *Pair) PushInBetween(e list.ElementerPointer) bool

type Subject

type Subject struct {
	list.List
	// contains filtered or unexported fields
}

func New

func New(coords []float64) (*Subject, error)

func (*Subject) Contains

func (s *Subject) Contains(pt maths.Pt) bool

Contains will test to see if the point if fully contained by the subject. If the point is on the broader it is not considered as contained.

func (*Subject) DebugStringAugmented

func (s *Subject) DebugStringAugmented(augmenter func(idx int, e maths.Pt) string) string

func (*Subject) FirstPair

func (s *Subject) FirstPair() *Pair

func (*Subject) GetPair

func (s *Subject) GetPair(idx int) *Pair

func (*Subject) GoString

func (s *Subject) GoString() string

func (*Subject) Init

func (s *Subject) Init(coords []float64) (*Subject, error)

func (*Subject) Winding

func (s *Subject) Winding() maths.WindingOrder