package geo

Import Path
	oss.terrastruct.com/d2/lib/geo (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 15 packages

Involved Source Files

	    bezier.go
	    box.go
	    ellipse.go
	    math.go
	    orientation.go
	    point.go
	    route.go
	    segment.go
	    spacing.go
	    vector.go
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type BezierCurve (struct)

		Fields (only one)
			Curve *bezier.Curve
		Methods (total 2)
			( BezierCurve) At(point float64) *Point
			( BezierCurve) Intersections(segment Segment) []*Point
		Implements (at least one exported)
			 BezierCurve : Intersectable
		As Outputs Of (at least one exported)
			func NewBezierCurve(points []*Point) *BezierCurve

	 type Box (struct)

		Fields (total 3)
			Height float64
			TopLeft *Point
			Width float64
		Methods (total 7)
			(*Box) Center() *Point
			(*Box) Contains(p *Point) bool
			(*Box) Copy() *Box
			(*Box) Intersections(s Segment) []*Point
			(*Box) Intersects(s Segment, buffer float64) bool
				Intersects returns true if the segment comes within buffer of the box

			( Box) Overlaps(b2 Box) bool
			(*Box) ToString() string
		Implements (at least one exported)
			*Box : Intersectable
		As Outputs Of (at least 5)
			func NewBox(tl *Point, width, height float64) *Box
			func (*Box).Copy() *Box
			func oss.terrastruct.com/d2/lib/shape.Shape.GetBox() *Box
			func oss.terrastruct.com/d2/lib/shape.Shape.GetInnerBox() *Box
			func oss.terrastruct.com/d2/lib/shape.Shape.GetInnerBoxForContent(width, height float64) *Box
		As Inputs Of (at least 26)
			func Box.Overlaps(b2 Box) bool
			func oss.terrastruct.com/d2/lib/label.Position.GetPointOnBox(box *Box, padding, width, height float64) *Point
			func oss.terrastruct.com/d2/lib/shape.NewCallout(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewCircle(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewClass(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewCloud(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewCode(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewCylinder(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewDiamond(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewDocument(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewHexagon(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewImage(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewOval(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewPackage(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewPage(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewParallelogram(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewPerson(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewQueue(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewRealSquare(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewShape(shapeType string, box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewSquare(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewStep(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewStoredData(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewTable(box *Box) shape.Shape
			func oss.terrastruct.com/d2/lib/shape.NewText(box *Box) shape.Shape
			func oss.terrastruct.com/d2/d2target.GetIconSize(box *Box, position string) int

	 type Ellipse (struct)

		Fields (total 3)
			Center *Point
			Rx float64
			Ry float64
		Methods (only one)
			( Ellipse) Intersections(segment Segment) []*Point
		Implements (at least one exported)
			 Ellipse : Intersectable
		As Outputs Of (at least one exported)
			func NewEllipse(center *Point, rx, ry float64) *Ellipse

	 type Intersectable (interface)

		Methods (only one)
			( Intersectable) Intersections(segment Segment) []*Point
		Implemented By (at least 5)
			 BezierCurve
			*Box
			 Ellipse
			 Segment
			 oss.terrastruct.com/d2/d2graph.Object
		As Outputs Of (at least one exported)
			func oss.terrastruct.com/d2/lib/shape.Shape.Perimeter() []Intersectable

	 type Orientation int (basic type)

		Methods (total 6)
			( Orientation) GetOpposite() Orientation
			( Orientation) IsDiagonal() bool
			( Orientation) IsHorizontal() bool
			( Orientation) IsVertical() bool
			( Orientation) SameSide(o2 Orientation) bool
			( Orientation) ToString() string
		As Outputs Of (at least 2)
			func Orientation.GetOpposite() Orientation
			func (*Point).GetOrientation(pTo *Point) Orientation
		As Inputs Of (at least one exported)
			func Orientation.SameSide(o2 Orientation) bool
		As Types Of (total 9)
			const Bottom
			const BottomLeft
			const BottomRight
			const Left
			const NONE
			const Right
			const Top
			const TopLeft
			const TopRight

	 type Point (struct)

		Fields (total 2)
			X float64
			Y float64
		Methods (total 15)
			(*Point) AddVector(v Vector) *Point
				Moves the given point by Vector

			(*Point) Compare(p2 *Point) int
			(*Point) Copy() *Point
			(*Point) DistanceToLine(p1, p2 *Point) float64
				https://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

			(*Point) Equals(p2 *Point) bool
			(*Point) FormattedCoordinates() string
			(*Point) GetOrientation(pTo *Point) Orientation
				GetOrientation gets orientation of pFrom to pTo
				E.g. pFrom ---> pTo, here, pFrom is to the left of pTo, so Left would be returned

			(*Point) Interpolate(b *Point, t float64) *Point
				point t% of the way between a and b

			(*Point) OnOrthogonalSegment(a, b *Point) bool
				returns true if point p is on orthogonal segment between points a and b

			(*Point) ToString() string
			(*Point) ToVector() Vector
				Creates a Vector pointing to point

			(*Point) Transpose()
			(*Point) TruncateDecimals()
			(*Point) TruncateFloat32()
			(*Point) VectorTo(endpoint *Point) Vector
				Creates a Vector of the size between start and endpoint, pointing to endpoint

		As Outputs Of (at least 31)
			func ComputeIntersections(px, py, lx, ly []float64) []*Point
			func IntersectionPoint(u0, u1, v0, v1 *Point) *Point
			func NewPoint(x, y float64) *Point
			func BezierCurve.At(point float64) *Point
			func BezierCurve.Intersections(segment Segment) []*Point
			func (*Box).Center() *Point
			func (*Box).Intersections(s Segment) []*Point
			func Ellipse.Intersections(segment Segment) []*Point
			func Intersectable.Intersections(segment Segment) []*Point
			func (*Point).AddVector(v Vector) *Point
			func (*Point).Copy() *Point
			func (*Point).Interpolate(b *Point, t float64) *Point
			func Points.GetMedian() *Point
			func Route.GetBoundingBox() (tl, br *Point)
			func Route.GetPointAtDistance(distance float64) (*Point, int)
			func Segment.Intersections(otherSegment Segment) []*Point
			func Vector.ToPoint() *Point
			func oss.terrastruct.com/d2/lib/label.Position.GetPointOnBox(box *Box, padding, width, height float64) *Point
			func oss.terrastruct.com/d2/lib/label.Position.GetPointOnRoute(route Route, strokeWidth, labelPercentage, width, height float64) (point *Point, index int)
			func oss.terrastruct.com/d2/lib/shape.TraceToShapeBorder(shape shape.Shape, rectBorderPoint, prevPoint *Point) *Point
			func oss.terrastruct.com/d2/lib/shape.Shape.GetInsidePlacement(width, height, paddingX, paddingY float64) Point
			func oss.terrastruct.com/d2/lib/svg.BezierCurveSegment(p1, p2, p3, p4 *Point, t0, t1 float64) (Point, Point, Point, Point)
			func oss.terrastruct.com/d2/lib/svg.BezierCurveSegment(p1, p2, p3, p4 *Point, t0, t1 float64) (Point, Point, Point, Point)
			func oss.terrastruct.com/d2/lib/svg.BezierCurveSegment(p1, p2, p3, p4 *Point, t0, t1 float64) (Point, Point, Point, Point)
			func oss.terrastruct.com/d2/lib/svg.BezierCurveSegment(p1, p2, p3, p4 *Point, t0, t1 float64) (Point, Point, Point, Point)
			func oss.terrastruct.com/d2/lib/svg.(*SvgPathContext).Absolute(x, y float64) *Point
			func oss.terrastruct.com/d2/lib/svg.(*SvgPathContext).Relative(base *Point, dx, dy float64) *Point
			func oss.terrastruct.com/d2/d2graph.(*Object).GetIconTopLeft() *Point
			func oss.terrastruct.com/d2/d2graph.(*Object).GetLabelTopLeft() *Point
			func oss.terrastruct.com/d2/d2target.(*Connection).GetArrowheadLabelPosition(isDst bool) *Point
			func oss.terrastruct.com/d2/d2target.(*Connection).GetLabelTopLeft() *Point
		As Inputs Of (at least 20)
			func IntersectionPoint(u0, u1, v0, v1 *Point) *Point
			func NewBezierCurve(points []*Point) *BezierCurve
			func NewBox(tl *Point, width, height float64) *Box
			func NewEllipse(center *Point, rx, ry float64) *Ellipse
			func NewSegment(from, to *Point) *Segment
			func (*Box).Contains(p *Point) bool
			func (*Point).Compare(p2 *Point) int
			func (*Point).DistanceToLine(p1, p2 *Point) float64
			func (*Point).Equals(p2 *Point) bool
			func (*Point).GetOrientation(pTo *Point) Orientation
			func (*Point).Interpolate(b *Point, t float64) *Point
			func (*Point).OnOrthogonalSegment(a, b *Point) bool
			func (*Point).VectorTo(endpoint *Point) Vector
			func oss.terrastruct.com/d2/lib/shape.TraceToShapeBorder(shape shape.Shape, rectBorderPoint, prevPoint *Point) *Point
			func oss.terrastruct.com/d2/lib/svg.BezierCurveSegment(p1, p2, p3, p4 *Point, t0, t1 float64) (Point, Point, Point, Point)
			func oss.terrastruct.com/d2/lib/svg.NewSVGPathContext(tl *Point, sx, sy float64) *svg.SvgPathContext
			func oss.terrastruct.com/d2/lib/svg.(*SvgPathContext).Relative(base *Point, dx, dy float64) *Point
			func oss.terrastruct.com/d2/lib/svg.(*SvgPathContext).StartAt(p *Point)
			func oss.terrastruct.com/d2/d2graph.(*Edge).TraceToShape(points []*Point, startIndex, endIndex int) (newStart, newEnd int)
			func oss.terrastruct.com/d2/d2renderers/d2sketch.Arrowheads(r jsrunner.JSRunner, connection d2target.Connection, srcAdj, dstAdj *Point) (string, error)

	 type Points ([])

		Methods (total 3)
			( Points) Equals(other Points) bool
			( Points) GetMedian() *Point
			( Points) ToString() string
		As Outputs Of (at least one exported)
			func RemovePoints(points Points, toRemove []bool) Points
		As Inputs Of (at least 2)
			func RemovePoints(points Points, toRemove []bool) Points
			func Points.Equals(other Points) bool

	 type RelativePoint (struct)

		Fields (total 2)
			XPercentage float64
			YPercentage float64
		As Outputs Of (at least one exported)
			func NewRelativePoint(xPercentage, yPercentage float64) *RelativePoint

	 type Route ([])

		Methods (total 3)
			( Route) GetBoundingBox() (tl, br *Point)
			( Route) GetPointAtDistance(distance float64) (*Point, int)
				return the point at _distance_ along the route, and the index of the segment it's on

			( Route) Length() float64
		As Inputs Of (at least one exported)
			func oss.terrastruct.com/d2/lib/label.Position.GetPointOnRoute(route Route, strokeWidth, labelPercentage, width, height float64) (point *Point, index int)

	 type Segment (struct)

		Fields (total 2)
			End *Point
			Start *Point
		Methods (total 7)
			(*Segment) GetBounds(segments []*Segment, buffer float64) (float64, float64)
				getBounds takes a segment and returns the floor and ceil of where it can shift to
				If there is no floor or ceiling, negative or positive infinity is used, respectively
				The direction is inferred, e.g. b/c the passed in segment is vertical, it's inferred we want horizontal bounds
				buffer says how close the segment can be, on both axes, to other segments given
				.    │              │
				.    │              │
				.    │              │
				.    │              │
				.    │           non-overlap
				.    │
				.    │
				.    │
				.    │     segment
				.    │       │
				.    │       │         ceil
				.    │       │            │
				.            │            │
				. floor      │            │
				.                         │
				.                         │
				.                         │
				.                         │
				NOTE: the assumption is that all segments given are orthogonal

			( Segment) Intersections(otherSegment Segment) []*Point
			( Segment) Intersects(otherSegment Segment) bool
			( Segment) Length() float64
			( Segment) Overlaps(otherS Segment, isHorizontal bool, buffer float64) bool
			( Segment) ToString() string
			( Segment) ToVector() Vector
		Implements (at least one exported)
			 Segment : Intersectable
		As Outputs Of (at least one exported)
			func NewSegment(from, to *Point) *Segment
		As Inputs Of (at least 9)
			func BezierCurve.Intersections(segment Segment) []*Point
			func (*Box).Intersections(s Segment) []*Point
			func (*Box).Intersects(s Segment, buffer float64) bool
			func Ellipse.Intersections(segment Segment) []*Point
			func Intersectable.Intersections(segment Segment) []*Point
			func (*Segment).GetBounds(segments []*Segment, buffer float64) (float64, float64)
			func Segment.Intersections(otherSegment Segment) []*Point
			func Segment.Intersects(otherSegment Segment) bool
			func Segment.Overlaps(otherS Segment, isHorizontal bool, buffer float64) bool

	 type Spacing (struct)

		Fields (total 4)
			Bottom float64
			Left float64
			Right float64
			Top float64
		As Outputs Of (at least 3)
			func oss.terrastruct.com/d2/d2graph.(*Object).GetMargin() Spacing
			func oss.terrastruct.com/d2/d2graph.(*Object).Spacing() (margin, padding Spacing)
			func oss.terrastruct.com/d2/d2graph.(*Object).SpacingOpt(labelPadding, iconPadding float64, maxIconSize bool) (margin, padding Spacing)
		As Inputs Of (at least one exported)
			func oss.terrastruct.com/d2/d2layouts.FitToGraph(container *d2graph.Object, nestedGraph *d2graph.Graph, padding Spacing)

	 type Vector ([])
		A N-Dimensional Vector with components (x, y, z, ...) based on the origin

		Methods (total 10)
			( Vector) Add(b Vector) Vector
			( Vector) AddLength(length float64) Vector
				Creates a Vector by extending the length of the current one by length

			( Vector) Degrees() float64
			( Vector) Length() float64
			( Vector) Minus(b Vector) Vector
			( Vector) Multiply(v float64) Vector
			( Vector) Radians() float64
			( Vector) Reverse() Vector
			( Vector) ToPoint() *Point
			( Vector) Unit() Vector
				Creates an unit Vector pointing in the same direction of this Vector

		As Outputs Of (at least 11)
			func NewVector(components ...float64) Vector
			func NewVectorFromProperties(length float64, angleInRadians float64) Vector
			func (*Point).ToVector() Vector
			func (*Point).VectorTo(endpoint *Point) Vector
			func Segment.ToVector() Vector
			func Vector.Add(b Vector) Vector
			func Vector.AddLength(length float64) Vector
			func Vector.Minus(b Vector) Vector
			func Vector.Multiply(v float64) Vector
			func Vector.Reverse() Vector
			func Vector.Unit() Vector
		As Inputs Of (at least 3)
			func (*Point).AddVector(v Vector) *Point
			func Vector.Add(b Vector) Vector
			func Vector.Minus(b Vector) Vector
		As Types Of (only one)
			  var oss.terrastruct.com/d2/d2target.BorderOffset


Package-Level Functions (total 16)

	 func ComputeIntersections(px, py, lx, ly []float64) []*Point
		nolint

	 func EuclideanDistance(x1, y1, x2, y2 float64) float64
	 func GetUnitNormalVector(x1, y1, x2, y2 float64) (float64, float64)
	 func IntersectionPoint(u0, u1, v0, v1 *Point) *Point
		get the point of intersection between line segments u and v (or nil if they do not intersect)

	 func NewBezierCurve(points []*Point) *BezierCurve
	 func NewBox(tl *Point, width, height float64) *Box
	 func NewEllipse(center *Point, rx, ry float64) *Ellipse
	 func NewPoint(x, y float64) *Point
	 func NewRelativePoint(xPercentage, yPercentage float64) *RelativePoint
	 func NewSegment(from, to *Point) *Segment
	 func NewVector(components ...float64) Vector
		New Vector from components

	 func NewVectorFromProperties(length float64, angleInRadians float64) Vector
		New Vector of length and pointing in the direction of angle

	 func PrecisionCompare(a, b, e float64) int
		compare a and b and consider them equal if
		difference is less than precision e (e.g. e=0.001)

	 func RemovePoints(points Points, toRemove []bool) Points
		RemovePoints returns a new Points slice without the points in toRemove

	 func Sign(i float64) int
	 func TruncateDecimals(v float64) float64
		TruncateDecimals truncates floats to keep up to 3 digits after decimal, to avoid issues with floats on different machines.
		Since we're not launching rockets, 3 decimals is enough precision for what we're doing


Package-Level Constants (total 10)

	const Bottom Orientation = 6
	const BottomLeft Orientation = 2
	const BottomRight Orientation = 3
	const Left Orientation = 7
	const NONE Orientation = 8
	const PRECISION = 0.0001
		How precise should comparisons be, avoid being too precise due to floating point issues

	const Right Orientation = 5
	const Top Orientation = 4
	const TopLeft Orientation = 0
	const TopRight Orientation = 1

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.