floatgeom

package
v4.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 6, 2024 License: Apache-2.0 Imports: 4 Imported by: 10

Documentation

Overview

Package floatgeom provides primitives for floating point geometry.

Index

Constants

This section is empty.

Variables

View Source 
var (
	Up        = Dir2(Point2{0, -1})
	Down      = Dir2(Point2{0, 1})
	Left      = Dir2(Point2{-1, 0})
	Right     = Dir2(Point2{1, 0})
	UpRight   = Up.And(Right)
	DownRight = Down.And(Right)
	DownLeft  = Down.And(Left)
	UpLeft    = Up.And(Left)
)

Dir2 values

Functions

func Distance2 

func Distance2(x1, y1, x2, y2 float64) float64

Distance2 calculates the euclidean distance between two points, as two (x,y) pairs

func Distance3 

func Distance3(x1, y1, z1, x2, y2, z2 float64) float64

Distance3 calculates the euclidean distance between two points, as two (x,y,z) triplets

Types

type Dir2 

type Dir2 Point2

Dir2 is a helper type for representing points as directions

func (Dir2) And 

func (d Dir2) And(d2 Dir2) Dir2

And combines two directions

func (Dir2) X 

func (d Dir2) X() float64

X retrieves the horizontal component of a Dir2

func (Dir2) Y 

func (d Dir2) Y() float64

Y retrieves the vertical component for a Dir2

type Point2 

type Point2 [2]float64

Point2 represents a 2D point on a plane.

func AnglePoint 

func AnglePoint(angle float64) Point2

AnglePoint creates a unit vector from the given angle in degrees as a Point2.

func RadianPoint 

func RadianPoint(radians float64) Point2

RadianPoint creates a unit vector from the given angle in radians as a Point2.

func (Point2) Add 

func (p Point2) Add(ps ...Point2) Point2

Add combines the input points via addition.

func (Point2) AngleTo 

func (p Point2) AngleTo(p2 Point2) float64

AngleTo returns the angle from p to p2 in degrees.

func (Point2) Dim 

func (p Point2) Dim(i int) float64

Dim returns the value of p in the ith dimension. Panics if i > 1.

func (Point2) Distance 

func (p Point2) Distance(p2 Point2) float64

Distance calculates the distance between this Point2 and another.

func (Point2) Div 

func (p Point2) Div(ps ...Point2) Point2

Div combines the input points via division. Div does not check that the inputs are non zero before operating, and can panic if that is not true.

func (Point2) DivConst 

func (p Point2) DivConst(fs ...float64) Point2

DivConst divides all elements of a point by the input floats DivConst does not check that the inputs are non zero before operating, and can panic if that is not true.

func (Point2) Dot 

func (p Point2) Dot(p2 Point2) float64

Dot returns the dot product of the input points

func (Point2) GreaterOf 

func (p Point2) GreaterOf(ps ...Point2) Point2

GreaterOf returns the highest values on each axis of the input points as a point.

func (Point2) LesserOf 

func (p Point2) LesserOf(ps ...Point2) Point2

LesserOf returns the lowest values on each axis of the input points as a point.

func (Point2) Magnitude 

func (p Point2) Magnitude() float64

Magnitude returns the magnitude of the combined components of a Point

func (Point2) Mul 

func (p Point2) Mul(ps ...Point2) Point2

Mul combines in the input points via multiplication.

func (Point2) MulConst 

func (p Point2) MulConst(fs ...float64) Point2

MulConst multiplies all elements of a point by the input floats

func (Point2) Normalize 

func (p Point2) Normalize() Point2

Normalize converts this point into a unit vector.

func (Point2) RadiansTo 

func (p Point2) RadiansTo(p2 Point2) float64

RadiansTo returns the angle from p to p2 in radians.

func (Point2) Rotate 

func (p Point2) Rotate(fs ...float64) Point2

Rotate takes in a set of angles and rotates v by their sum the input angles are expected to be in degrees.

func (Point2) RotateRadians 

func (p Point2) RotateRadians(fs ...float64) Point2

RotateRadians takes in a set of angles and rotates v by their sum the input angles are expected to be in radians.

func (Point2) Sub 

func (p Point2) Sub(ps ...Point2) Point2

Sub combines the input points via subtraction.

func (Point2) ToAngle 

func (p Point2) ToAngle() float64

ToAngle returns this point as an angle in degrees.

func (Point2) ToRadians 

func (p Point2) ToRadians() float64

ToRadians returns this point as an angle in radians.

func (Point2) ToRect 

func (p Point2) ToRect(span float64) Rect2

ToRect converts this point into a rectangle spanning span distance in each axis.

func (Point2) X 

func (p Point2) X() float64

X returns p's value on the X axis.

func (Point2) Y 

func (p Point2) Y() float64

Y returns p's value on the Y axis.

type Point3 

type Point3 [3]float64

Point3 represents a 3D point in space.

func (Point3) Add 

func (p Point3) Add(ps ...Point3) Point3

Add combines the input points via addition.

func (Point3) Cross 

func (p Point3) Cross(p2 Point3) Point3

Cross gets the cross product of two Point 3s

func (Point3) Dim 

func (p Point3) Dim(i int) float64

Dim returns the value of p in the ith dimension. Panics if i > 2.

func (Point3) Distance 

func (p Point3) Distance(p2 Point3) float64

Distance calculates the distance between this Point3 and another.

func (Point3) Div 

func (p Point3) Div(ps ...Point3) Point3

Div combines the input points via division. Div does not check that the inputs are non zero before operating, and can panic if that is not true.

func (Point3) DivConst 

func (p Point3) DivConst(fs ...float64) Point3

DivConst divides all elements of a point by the input floats DivConst does not check that the inputs are non zero before operating, and can panic if that is not true.

func (Point3) Dot 

func (p Point3) Dot(p2 Point3) float64

Dot returns the dot product of the input points

func (Point3) GreaterOf 

func (p Point3) GreaterOf(ps ...Point3) Point3

GreaterOf returns the highest values on each axis of the input points as a point.

func (Point3) LesserOf 

func (p Point3) LesserOf(ps ...Point3) Point3

LesserOf returns the lowest values on each axis of the input points as a point.

func (Point3) Magnitude 

func (p Point3) Magnitude() float64

Magnitude returns the magnitude of the combined components of a Point

func (Point3) Mul 

func (p Point3) Mul(ps ...Point3) Point3

Mul combines in the input points via multiplication.

func (Point3) MulConst 

func (p Point3) MulConst(fs ...float64) Point3

MulConst multiplies all elements of a point by the input floats

func (Point3) Normalize 

func (p Point3) Normalize() Point3

Normalize converts this point into a unit vector.

func (Point3) ProjectX 

func (p Point3) ProjectX() Point2

ProjectX projects the Point3 onto the x axis, removing it's x component and returning a Point2

func (Point3) ProjectY 

func (p Point3) ProjectY() Point2

ProjectY projects the Point3 onto the y axis, removing it's y component and returning a Point2

func (Point3) ProjectZ 

func (p Point3) ProjectZ() Point2

ProjectZ projects the Point3 onto the z axis, removing it's z component and returning a Point2

func (Point3) Sub 

func (p Point3) Sub(ps ...Point3) Point3

Sub combines the input points via subtraction.

func (Point3) ToRect 

func (p Point3) ToRect(span float64) Rect3

ToRect converts this point into a rectangle spanning span distance in each axis.

func (Point3) X 

func (p Point3) X() float64

X returns p's value on the X axis.

func (Point3) Y 

func (p Point3) Y() float64

Y returns p's value on the Y axis.

func (Point3) Z 

func (p Point3) Z() float64

Z returns p's value on the Z axis.

type Point4 

type Point4 [4]float64

Point4 represents a 4D point, in space + some additional dimension.

func (Point4) Conjugate 

func (p Point4) Conjugate() Point4

Conjugate returns a value of a Point4 often obtained to calculate the inverse

func (Point4) Dim 

func (p Point4) Dim(i int) float64

Dim returns the value of p in the ith dimension. Panics if i > 3.

func (Point4) DivConst 

func (p Point4) DivConst(fs ...float64) Point4

DivConst divides all elements of a point by the input floats DivConst does not check that the inputs are non zero before operating, and can panic if that is not true.

func (Point4) Dot 

func (p Point4) Dot(p2 Point4) float64

Dot returns the dot product of the input points

func (Point4) Inverse 

func (p Point4) Inverse() Point4

Inverse of a Point4, often used to get the inverse rotation of a quaternion

func (Point4) Magnitude 

func (p Point4) Magnitude() float64

Magnitude returns the magnitude of the combined components of a Point

func (Point4) MulConst 

func (p Point4) MulConst(fs ...float64) Point4

MulConst multiplies all elements of a point by the input floats

func (Point4) MulQuat 

func (p Point4) MulQuat(p2 Point4) Point4

MulQuat multiplies two quaternions to generate a combined quarternion that represents both rotations ref: https://www.mathworks.com/help/aeroblks/quaternionmultiplication.html

func (Point4) Normalize 

func (p Point4) Normalize() Point4

Normalize converts this point into a unit vector.

func (Point4) W 

func (p Point4) W() float64

W returns p's value on the W axis.

func (Point4) X 

func (p Point4) X() float64

X returns p's value on the X axis.

func (Point4) Y 

func (p Point4) Y() float64

Y returns p's value on the Y axis.

func (Point4) Z 

func (p Point4) Z() float64

Z returns p's value on the Z axis.

type Polygon2 

type Polygon2 struct {
	// Bounding is a cached bounding box calculated from the input points
	// It is exported for convenience, but should be modified with care
	Bounding Rect2
	// The component points of the polygon. If modified, Bounding should
	// be updated with NewBoundingRect2.
	Points []Point2
	// contains filtered or unexported fields
}

A Polygon2 is a series of points in 2D space.

func NewPolygon2 

func NewPolygon2(p1, p2, p3 Point2, pn ...Point2) Polygon2

NewPolygon2 is a helper method to construct a valid polygon. Polygons cannot contain less than 3 points.

func (Polygon2) Contains 

func (pg Polygon2) Contains(x, y float64) (contains bool)

Contains returns whether or not the current Polygon contains the passed in Point. If it is known that the polygon is convex, ConvexContains should be preferred for performance.

func (Polygon2) ConvexContains 

func (pg Polygon2) ConvexContains(x, y float64) bool

ConvexContains returns whether the given point is contained by the input polygon. It assumes the polygon is convex.

func (Polygon2) OverlappingRectCollides 

func (pg Polygon2) OverlappingRectCollides(r Rect2) bool

OverlappingRectCollides returns whether a Rect2 intersects or is contained by this Polygon. This method differs from RectCollides because it assumes that we already know r overlaps with pg.Bounding. It is only valid for convex polygons.

func (Polygon2) RectCollides 

func (pg Polygon2) RectCollides(r Rect2) bool

RectCollides returns whether a Rect2 intersects or is contained by this Polygon. It is only valid for convex polygons.

type Rect2 

type Rect2 struct {
	Min, Max Point2
}

A Rect2 represents a span from one point in 2D space to another. If Min is less than max on any axis, it will return undefined results for methods.

func NewBoundingRect2 

func NewBoundingRect2(pts ...Point2) Rect2

NewBoundingRect2 will produce the minimal rectangle that contains all of the input points.

func NewRect2 

func NewRect2(x, y, x2, y2 float64) Rect2

NewRect2 returns an (X,Y):(X2,Y2) rectangle. This enforces that x < x2 and y < y2, and will swap the inputs if that is not true. If that enforcement is not desired, construct the struct manually.

func NewRect2WH 

func NewRect2WH(x, y, w, h float64) Rect2

NewRect2WH returns an (X,Y):(X+W,Y+H) rectangle. This enforces that w and h are positive, and will decrease x and y respectively if that is not true.

func (Rect2) Area 

func (r Rect2) Area() float64

Area returns W * H.

func (Rect2) Center 

func (r Rect2) Center() Point2

Center returns the center of this rectangle

func (Rect2) Clamp added in v4.1.0 

func (r Rect2) Clamp(pt Point2) Point2

Clamp returns a version of the provided point such that it is contained within r. If it was already contained in r, it will not be changed.

func (Rect2) Contains 

func (r Rect2) Contains(p Point2) bool

Contains tests whether p is located inside or on the boundary of r.

func (Rect2) ContainsRect 

func (r Rect2) ContainsRect(r2 Rect2) bool

ContainsRect tests whether r2 is is located inside r1.

func (Rect2) GreaterOf 

func (r Rect2) GreaterOf(r2 Rect2) Rect2

GreaterOf returns a rectangle formed of the lowest values on each dimension for Min, and the highest for Max.

func (Rect2) H 

func (r Rect2) H() float64

H returns the height of this rectangle.

func (Rect2) Intersects 

func (r Rect2) Intersects(r2 Rect2) bool

Intersects returns whether the two rectangles intersect.

func (Rect2) MaxDimensions 

func (r Rect2) MaxDimensions() int

MaxDimensions reports that a Rect2 has only two dimensions of definition.

func (Rect2) Midpoint 

func (r Rect2) Midpoint(i int) float64

Midpoint returns the midpoint of this rectangle's span over a given dimension.

func (Rect2) MulConst added in v4.1.0 

func (r Rect2) MulConst(i float64) Rect2

MulConst multiplies the boundary points of this rectangle by i.

func (Rect2) MulSpan added in v4.1.0 

func (r Rect2) MulSpan(f float64) span.Span[Point2]

MulSpan returns this rectangle as a Point2 Span after multiplying the boundary points of the rectangle by f.

func (Rect2) Percentile added in v4.1.0 

func (r Rect2) Percentile(f float64) Point2

Percentile returns a point within this rectangle along the vector from the top left to the bottom right of the rectangle, where for example, 0.0 will be r.Min, 1.0 will be r.Max, and 2.0 will be project the vector beyond r and return r.Min + {r.W()*2, r.H()*2}

func (Rect2) Perimeter 

func (r Rect2) Perimeter() float64

Perimeter computes the sum of the edge lengths of a rectangle.

func (Rect2) Poll added in v4.1.0 

func (r Rect2) Poll() Point2

Poll returns a pseudorandom point from within this rectangle

func (Rect2) Shift 

func (r Rect2) Shift(p Point2) Rect2

Shift moves the rectangle by a point returns a new instance

func (Rect2) Span 

func (r Rect2) Span(i int) float64

Span returns the span on this rectangle's ith axis.

func (Rect2) W 

func (r Rect2) W() float64

W returns the width of this rectangle.

type Rect3 

type Rect3 struct {
	Min, Max Point3
}

A Rect3 represents a span from one point in 3D space to another. If Min is less than Max on any axis, it will return undefined results for methods.

func NewBoundingRect3 

func NewBoundingRect3(pts ...Point3) Rect3

NewBoundingRect3 will produce the minimal rectangle that contains all of the input points.

func NewRect3 

func NewRect3(x, y, z, x2, y2, z2 float64) Rect3

NewRect3 returns an (X,Y,Z):(X2,Y2,Z2) rectangle. This enforces that x < x2, y < y2, and z < z2, and will swap the inputs if that is not true.

func NewRect3WH 

func NewRect3WH(x, y, z, w, h, d float64) Rect3

NewRect3WH returns an (X,Y,Z):(X+W,Y+H,Z+D) rectangle. This enforces that w, h, and d and positive, and will decrease x, y, and z respectively if that is not true.

func (Rect3) Center 

func (r Rect3) Center() Point3

Center returns the center of this rectangle

func (Rect3) Clamp added in v4.1.0 

func (r Rect3) Clamp(pt Point3) Point3

Clamp returns a version of the provided point such that it is contained within r. If it was already contained in r, it will not be changed.

func (Rect3) Contains 

func (r Rect3) Contains(p Point3) bool

Contains tests whether p is located inside or on the boundary of r.

func (Rect3) ContainsRect 

func (r Rect3) ContainsRect(r2 Rect3) bool

ContainsRect tests whether r2 is is located inside r1.

func (Rect3) D 

func (r Rect3) D() float64

D returns the depth of this rectangle.

func (Rect3) GreaterOf 

func (r Rect3) GreaterOf(r2 Rect3) Rect3

GreaterOf returns a rectangle formed of the lowest values on each dimension for Min, and the highest for Max.

func (Rect3) H 

func (r Rect3) H() float64

H returns the height of this rectangle.

func (Rect3) Intersects 

func (r Rect3) Intersects(r2 Rect3) bool

Intersects returns whether the two rectangles intersect.

func (Rect3) Margin 

func (r Rect3) Margin() float64

Margin computes the sum of the edge lengths of a rectangle.

func (Rect3) MaxDimensions 

func (r Rect3) MaxDimensions() int

MaxDimensions reports that a Rect3 has only three dimensions of definition.

func (Rect3) Midpoint 

func (r Rect3) Midpoint(i int) float64

Midpoint returns the midpoint of this rectangle's span over a given dimension.

func (Rect3) MulConst added in v4.1.0 

func (r Rect3) MulConst(i float64) Rect3

MulConst multiplies the boundary points of this rectangle by i.

func (Rect3) MulSpan added in v4.1.0 

func (r Rect3) MulSpan(f float64) span.Span[Point3]

MulConst multiplies the boundary points of this rectangle by i.

func (Rect3) Percentile added in v4.1.0 

func (r Rect3) Percentile(f float64) Point3

Percentile returns a point within this rectangle along the vector from the top left to the bottom right of the rectangle, where for example, 0.0 will be r.Min, 1.0 will be r.Max, and 2.0 will be project the vector beyond r and return r.Min + {r.W()*2, r.H()*2, r.D()*2}

func (Rect3) Poll added in v4.1.0 

func (r Rect3) Poll() Point3

Poll returns a pseudorandom point from within this rectangle

func (Rect3) ProjectZ 

func (r Rect3) ProjectZ() Rect2

ProjectZ projects the Rect3 onto the z axis, removing it's z component and returning a Rect2

func (Rect3) Shift 

func (r Rect3) Shift(p Point3) Rect3

Shift moves the rectangle by a point returns a new instance

func (Rect3) Space 

func (r Rect3) Space() float64

Space returns W * H * D

func (Rect3) Span 

func (r Rect3) Span(i int) float64

Span returns the span on this rectangle's ith axis.

func (Rect3) W 

func (r Rect3) W() float64

W returns the width of this rectangle.

type Tri3 

type Tri3 [3]Point3

Tri3 is a triangle of Point3s

func (Tri3) Barycentric 

func (t Tri3) Barycentric(x, y float64) Point3

Barycentric finds the barycentric coordinates of the given x,y cartesian coordinates within this triangle. If the point (x,y) is outside of the triangle, one of the output values will be negative. Credit goes to github.com/yellingintothefan for their work in gel

func (Tri3) Normal 

func (t Tri3) Normal() Point3

Normal calculates the surface normal of a triangle

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.