README
¶
Vector
A 3D and 2D Vector Library, In Golang
go get git.red-green.com/david/vector
Quickstart
package main
import (
"fmt"
vec "git.red-green.com/david/vector"
)
func main() {
// 3D
var v vec.Vec = vec.NewVec3()
fmt.Printf("Hello v, %s\r\n", v)
// Hello v, (0, 0, 0)
// 2D
var v2 vec.Vec = vec.NewVec2(2, -2)
fmt.Printf("Oh, Hi v2, %s\r\n", v2)
// Oh, Hi v2, (2, -2)
// Or auto detect
// 3D
var v3 vec.Vec = vec.NewVec()
fmt.Printf("v3 = %s\r\n", v3)
// v3 = (0, 0, 0)
// 2D
var v4 vec.Vec = vec.NewVec(2, -2)
fmt.Printf("v4 = %s\r\n", v4)
// v4 = (2, -2)
}
Library Info
Types
vector.Vecinterface/generic of*vector.Vec2or*vector.Vec3vector.Vec2struct { X int64, Y int64 }vector.Vec3struct { X int64, Y int64, Z int64 }
Many methods will return the generic vector.Vec instead of the
direct Vec2 or Vec3 to satisfy the Vec interface (Use Is2D
or Is3D to determine Vec2 or Vec3 and convert to *Vec2 or
*Vec3 from there, i.e. var v1 *vec.Vec2 = v.(*vec.Vec2) or var v1 *vec.Vec3 = v.(*vec.Vec3))
Constructor (Generic/Auto)
vector.NewVec(...int64) vector.Vec- 0 to 1 values will result in nil (Use
vector.NewVec2orvector.NewVec3to obtain a zeroed Vec) - 2 values will result in a
*vector.Vec2with X and Y - 3+ values will result in a
*vector.Vec3with X, Y and Z - 4 or more values are not used
- 0 to 1 values will result in nil (Use
vector.VecFrom(vector.Vec) vector.Vec- A nil will result in nil (
vector.Vec2Fromorvector.Vec3Fromwill make zeroed copies instead) - A
*vector.Vec2will result in a*vector.Vec2with X and Y copied - A
*vector.Vec3will result in a*vector.Vec3with X, Y and Z copied
- A nil will result in nil (
vector.VecString(string) (Vec, error)- Given a string of a vector (You can use
Vec2.String()orVec3.String()to make this quickly) - string requirements:
- Must start with a
(and end with a)(missing parentheses) - Must contain from 1 to 2
,(invalid comma count: expected 1-2 got #)- 1 comma for a 2D
vector.Vec2(X, Y) - 2 commas for a 3D
vector.Vec3(X, Y, Z)
- 1 comma for a 2D
vector.Vec2String(string) (Vec, error)will expect the string to make a validVec2rather than aVec3(AVec3will be converted)vector.Vec3String(string) (Vec, error)will expect the string to make a validVec3rather than aVec2(AVec2will be converted)
- Must start with a
- Given a string of a vector (You can use
Documentation
¶
Index ¶
- Variables
- type Vec
- type Vec2
- func (v *Vec2) Abs() Vec
- func (v *Vec2) Clone() Vec
- func (v *Vec2) CloneDown() Vec
- func (v *Vec2) Distance(axis ...int64) int64
- func (v *Vec2) DistanceTo(o Vec) int64
- func (v *Vec2) Eq(axis ...int64) bool
- func (v *Vec2) EqTo(o Vec) bool
- func (v *Vec2) Greater(axis ...int64) bool
- func (v *Vec2) GreaterThan(o Vec) bool
- func (v *Vec2) Is2D() bool
- func (v *Vec2) Is3D() bool
- func (v *Vec2) IsNegative() bool
- func (v *Vec2) IsPositive() bool
- func (v *Vec2) IsZero() bool
- func (v *Vec2) Less(axis ...int64) bool
- func (v *Vec2) LessThan(o Vec) bool
- func (v *Vec2) Move(axis ...int64) Vec
- func (v *Vec2) MoveBy(o Vec) Vec
- func (v *Vec2) Negate() Vec
- func (v *Vec2) Set(axis ...int64) Vec
- func (v *Vec2) SetTo(o Vec) Vec
- func (v *Vec2) String() string
- func (v *Vec2) Within(corner1, corner2 Vec) bool
- func (v *Vec2) X(x ...int64) int64
- func (v *Vec2) Y(y ...int64) int64
- func (v *Vec2) Z(z ...int64) int64
- func (v *Vec2) Zero() Vec
- type Vec3
- func (v *Vec3) Abs() Vec
- func (v *Vec3) Clone() Vec
- func (v *Vec3) CloneDown() Vec
- func (v *Vec3) Distance(axis ...int64) int64
- func (v *Vec3) DistanceTo(o Vec) int64
- func (v *Vec3) Eq(axis ...int64) bool
- func (v *Vec3) EqTo(o Vec) bool
- func (v *Vec3) Greater(axis ...int64) bool
- func (v *Vec3) GreaterThan(o Vec) bool
- func (v *Vec3) Is2D() bool
- func (v *Vec3) Is3D() bool
- func (v *Vec3) IsNegative() bool
- func (v *Vec3) IsPositive() bool
- func (v *Vec3) IsZero() bool
- func (v *Vec3) Less(axis ...int64) bool
- func (v *Vec3) LessThan(o Vec) bool
- func (v *Vec3) Move(axis ...int64) Vec
- func (v *Vec3) MoveBy(o Vec) Vec
- func (v *Vec3) Negate() Vec
- func (v *Vec3) Set(axis ...int64) Vec
- func (v *Vec3) SetTo(o Vec) Vec
- func (v *Vec3) String() string
- func (v *Vec3) Within(corner1, corner2 Vec) bool
- func (v *Vec3) X(x ...int64) int64
- func (v *Vec3) Y(y ...int64) int64
- func (v *Vec3) Z(z ...int64) int64
- func (v *Vec3) Zero() Vec
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Vec ¶
type Vec interface {
X(...int64) int64
Y(...int64) int64
Z(...int64) int64
Is2D() bool
Is3D() bool
Clone() Vec
CloneDown() Vec
IsZero() bool
Zero() Vec
Abs() Vec
Negate() Vec
IsPositive() bool
IsNegative() bool
String() string
Set(...int64) Vec
Move(...int64) Vec
SetTo(Vec) Vec
MoveBy(Vec) Vec
Eq(...int64) bool
EqTo(Vec) bool
Less(...int64) bool
Greater(...int64) bool
LessThan(Vec) bool
GreaterThan(Vec) bool
Distance(...int64) int64
DistanceTo(Vec) int64
Within(Vec, Vec) bool
}
func Vec2String ¶
func Vec3String ¶
type Vec2 ¶
type Vec2 struct {
// contains filtered or unexported fields
}
A Point or Velocity in Space
func (*Vec2) DistanceTo ¶
func (*Vec2) GreaterThan ¶
func (*Vec2) IsNegative ¶
func (*Vec2) IsPositive ¶
type Vec3 ¶
type Vec3 struct {
// contains filtered or unexported fields
}
A Point or Velocity in Space
func (*Vec3) DistanceTo ¶
func (*Vec3) GreaterThan ¶
func (*Vec3) IsNegative ¶
func (*Vec3) IsPositive ¶
Source Files
Click to show internal directories.
Click to hide internal directories.