vector3

package
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Jun 30, 2023 License: MIT Imports: 6 Imported by: 74

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Array

type Array[T vector.Number] []Vector[T]

func (Array[T]) Add

func (v3a Array[T]) Add(other Vector[T]) (out Array[T])

func (Array[T]) Average

func (v3a Array[T]) Average(vectors []Vector[T]) Vector[float64]

Average sums all vector3's components together and divides each component by the number of values added

func (Array[T]) Bounds

func (v3a Array[T]) Bounds() (Vector[T], Vector[T])

Bounds returns the min and max points of an AABB encompassing

func (Array[T]) Distance

func (v3a Array[T]) Distance() float64

func (Array[T]) DivByConstant

func (v3a Array[T]) DivByConstant(t float64) (out Array[T])

func (Array[T]) Modify

func (v3a Array[T]) Modify(f func(Vector[T]) Vector[T]) (out Array[T])

func (Array[T]) Normalized

func (v3a Array[T]) Normalized() (out Array[T])

func (Array[T]) Scale

func (v3a Array[T]) Scale(t float64) (out Array[T])

func (Array[T]) StandardDeviation added in v1.0.2

func (v3a Array[T]) StandardDeviation() (mean, deviation Vector[float64])

StandardDeviation calculates the population standard deviation on each component of the vector

func (Array[T]) Sum

func (v3a Array[T]) Sum() (sum Vector[T])

type Float32

type Float32 = Vector[float32]

type Float32Array

type Float32Array = Array[float32]

type Float64

type Float64 = Vector[float64]

func FromColor added in v1.1.0

func FromColor(c color.Color) Float64

type Float64Array

type Float64Array = Array[float64]

type Int

type Int = Vector[int]

type Int16 added in v1.2.0

type Int16 = Vector[int16]

type Int32 added in v1.2.0

type Int32 = Vector[int32]

type Int64

type Int64 = Vector[int64]

type Int64Array

type Int64Array = Array[int64]

type Int8 added in v1.2.0

type Int8 = Vector[int8]

type IntArray

type IntArray = Array[int]

type Vector

type Vector[T vector.Number] struct {
	// contains filtered or unexported fields
}

Vector contains 3 components

func Average

func Average[T vector.Number](vectors []Vector[T]) Vector[T]

Average sums all vector3's components together and divides each component by the number of vectors added

func Backwards

func Backwards[T vector.Number]() Vector[T]

Backwards is (0, 0, -1)

func Down

func Down[T vector.Number]() Vector[T]

Down is (0, -1, 0)

func Fill added in v1.1.0

func Fill[T vector.Number](v T) Vector[T]

Fill creates a vector where each component is equal to v

func Forward

func Forward[T vector.Number]() Vector[T]

Forward is (0, 0, 1)

func FromArray added in v1.1.0

func FromArray[T vector.Number](data []T) Vector[T]

Builds a vector from the data found from the passed in array to the best of it's ability. If the length of the array is smaller than the vector itself, only those values will be used to build the vector, and the remaining vector components will remain the default value of the vector's data type (some version of 0).

func Left

func Left[T vector.Number]() Vector[T]

Left is (-1, 0, 0)

func Lerp added in v1.0.2

func Lerp[T vector.Number](a, b Vector[T], t float64) Vector[T]

Lerp linearly interpolates between a and b by t

func Max added in v1.0.2

func Max[T vector.Number](a, b Vector[T]) Vector[T]

func Midpoint added in v1.1.0

func Midpoint[T vector.Number](a, b Vector[T]) Vector[T]

func Min added in v1.0.2

func Min[T vector.Number](a, b Vector[T]) Vector[T]

func New

func New[T vector.Number](x T, y T, z T) Vector[T]

New creates a new vector with corresponding 3 components

func One

func One[T vector.Number]() Vector[T]

One is (1, 1, 1)

func Rand

func Rand(r *rand.Rand) Vector[float64]

Rand returns a vector with each component being a random value between [0.0, 1.0)

func RandInUnitSphere added in v1.0.2

func RandInUnitSphere(r *rand.Rand) Vector[float64]

RandInUnitSphere returns a randomly sampled point in or on the unit

func RandNormal added in v1.0.3

func RandNormal(r *rand.Rand) Vector[float64]

RandNormal returns a random normal

func RandRange added in v1.0.3

func RandRange[T vector.Number](r *rand.Rand, min, max T) Vector[T]

RandRange returns a vector where each component is a random value that falls within the values of min and max

func Right[T vector.Number]() Vector[T]

Right is (1, 0, 0)

func Up

func Up[T vector.Number]() Vector[T]

Up is (0, 1, 0)

func Zero

func Zero[T vector.Number]() Vector[T]

Zero is (0, 0, 0)

func (Vector[T]) Abs

func (v Vector[T]) Abs() Vector[T]

Abs applies the Abs math operation to each component of the vector

func (Vector[T]) Add

func (v Vector[T]) Add(other Vector[T]) Vector[T]

Add takes each component of our vector and adds them to the vector passed in, returning a resulting vector

func (Vector[T]) Angle

func (v Vector[T]) Angle(other Vector[T]) float64

func (Vector[T]) Ceil

func (v Vector[T]) Ceil() Vector[T]

Ceil applies the ceil math operation to each component of the vector

func (Vector[T]) CeilToInt

func (v Vector[T]) CeilToInt() Vector[int]

CeilToInt applies the ceil math operation to each component of the vector, and then casts it to a int

func (Vector[T]) Clamp added in v1.0.3

func (v Vector[T]) Clamp(min, max T) Vector[T]

func (Vector[T]) Cross

func (v Vector[T]) Cross(other Vector[T]) Vector[T]

func (Vector[T]) Distance

func (v Vector[T]) Distance(other Vector[T]) float64

func (Vector[T]) DistanceSquared

func (v Vector[T]) DistanceSquared(other Vector[T]) float64

func (Vector[T]) DivByConstant

func (v Vector[T]) DivByConstant(t float64) Vector[T]

func (Vector[T]) Dot

func (v Vector[T]) Dot(other Vector[T]) float64

func (Vector[T]) Floor

func (v Vector[T]) Floor() Vector[T]

Floor applies the floor math operation to each component of the vector

func (Vector[T]) FloorToInt

func (v Vector[T]) FloorToInt() Vector[int]

FloorToInt applies the floor math operation to each component of the vector, and then casts it to a int

func (Vector[T]) Length

func (v Vector[T]) Length() float64

func (Vector[T]) LengthSquared

func (v Vector[T]) LengthSquared() float64

func (Vector[T]) MarshalJSON added in v1.0.4

func (v Vector[T]) MarshalJSON() ([]byte, error)

func (Vector[T]) MaxComponent added in v1.2.0

func (v Vector[T]) MaxComponent() T

func (Vector[T]) Midpoint added in v1.0.2

func (v Vector[T]) Midpoint(o Vector[T]) Vector[T]

Midpoint returns the midpoint between this vector and the vector passed in.

func (Vector[T]) MinComponent added in v1.2.0

func (v Vector[T]) MinComponent() T

func (Vector[T]) MultByVector

func (v Vector[T]) MultByVector(o Vector[T]) Vector[T]

MultByVector is component wise multiplication, also known as Hadamard product.

func (Vector[T]) NearZero added in v1.0.3

func (v Vector[T]) NearZero() bool

func (Vector[T]) Normalized

func (v Vector[T]) Normalized() Vector[T]

func (Vector[T]) Perpendicular

func (v Vector[T]) Perpendicular() Vector[T]

Perpendicular finds a vector that meets this vector at a right angle. https://stackoverflow.com/a/11132720/4974261

func (Vector[T]) Reflect added in v1.0.3

func (v Vector[T]) Reflect(normal Vector[T]) Vector[T]

func (Vector[T]) Refract added in v1.0.3

func (v Vector[T]) Refract(normal Vector[T], etaiOverEtat float64) Vector[T]

func (Vector[T]) Round

func (v Vector[T]) Round() Vector[T]

Round takes each component of the vector and rounds it to the nearest whole number

func (Vector[T]) RoundToInt

func (v Vector[T]) RoundToInt() Vector[int]

RoundToInt takes each component of the vector and rounds it to the nearest whole number, and then casts it to a int

func (Vector[T]) Scale

func (v Vector[T]) Scale(t float64) Vector[T]

func (Vector[T]) SetX

func (v Vector[T]) SetX(newX T) Vector[T]

SetX changes the x component of the vector

func (Vector[T]) SetY

func (v Vector[T]) SetY(newY T) Vector[T]

SetY changes the y component of the vector

func (Vector[T]) SetZ

func (v Vector[T]) SetZ(newZ T) Vector[T]

SetZ changes the z component of the vector

func (Vector[T]) Sqrt added in v1.0.3

func (v Vector[T]) Sqrt() Vector[T]

Sqrt applies the math.Sqrt to each component of the vector

func (Vector[T]) Sub

func (v Vector[T]) Sub(other Vector[T]) Vector[T]

func (Vector[T]) ToArr added in v1.0.5

func (v Vector[T]) ToArr() []T

func (Vector[T]) ToFloat32 added in v1.0.2

func (v Vector[T]) ToFloat32() Vector[float32]

func (Vector[T]) ToFloat64

func (v Vector[T]) ToFloat64() Vector[float64]

func (Vector[T]) ToInt

func (v Vector[T]) ToInt() Vector[int]

func (Vector[T]) ToInt64 added in v1.0.2

func (v Vector[T]) ToInt64() Vector[int64]

func (*Vector[T]) UnmarshalJSON added in v1.0.4

func (v *Vector[T]) UnmarshalJSON(data []byte) error

func (Vector[T]) X

func (v Vector[T]) X() T

X returns the x component

func (Vector[T]) XY

func (v Vector[T]) XY() vector2.Vector[T]

XY returns vector2 with the x and y components

func (Vector[T]) XZ

func (v Vector[T]) XZ() vector2.Vector[T]

XZ returns vector2 with the x and z components

func (Vector[T]) XZY added in v1.2.0

func (v Vector[T]) XZY() Vector[T]

func (Vector[T]) Y

func (v Vector[T]) Y() T

Y returns the y component

func (Vector[T]) YXZ added in v1.2.0

func (v Vector[T]) YXZ() Vector[T]

func (Vector[T]) YZ

func (v Vector[T]) YZ() vector2.Vector[T]

YZ returns vector2 with the y and z components

func (Vector[T]) YZX added in v1.2.0

func (v Vector[T]) YZX() Vector[T]

func (Vector[T]) Z

func (v Vector[T]) Z() T

Z returns the z component

func (Vector[T]) ZXY added in v1.2.0

func (v Vector[T]) ZXY() Vector[T]

func (Vector[T]) ZYX added in v1.2.0

func (v Vector[T]) ZYX() Vector[T]

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL