vec3

Documentation

Overview

Package vec3 provides utility functions to work with vectors.

Index

• func Dot(v1 *Vec3Impl, v2 *Vec3Impl) float64
• func Equals(v0, v1 *Vec3Impl) bool
• type Vec3Impl
  • func Add(v1 *Vec3Impl, args ...*Vec3Impl) *Vec3Impl
  • func Cross(v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl
  • func DeNAN(v *Vec3Impl) *Vec3Impl
  • func Div(v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl
  • func Lerp(v0, v1 *Vec3Impl, t float64) *Vec3Impl
  • func Max3(v0 *Vec3Impl, v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl
  • func Min3(v0 *Vec3Impl, v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl
  • func Mul(v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl
  • func RandomCosineDirection(random *fastrandom.LCG) *Vec3Impl
  • func RandomToSphere(radius float64, distanceSquared float64, random *fastrandom.LCG) *Vec3Impl
  • func ScalarDiv(v1 *Vec3Impl, t float64) *Vec3Impl
  • func ScalarMul(v1 *Vec3Impl, t float64) *Vec3Impl
  • func Sub(v1 *Vec3Impl, args ...*Vec3Impl) *Vec3Impl
  • func UnitVector(v *Vec3Impl) *Vec3Impl
  • func (v *Vec3Impl) Length() float64
  • func (v *Vec3Impl) MakeUnitVector()
  • func (v *Vec3Impl) SquaredLength() float64

Functions

func Dot

func Dot(v1 *Vec3Impl, v2 *Vec3Impl) float64

Dot computes the dot product of the two supplied vectors.

func Equals

func Equals(v0, v1 *Vec3Impl) bool

Equals returns whether two vectors are the same.

Types

type Vec3Impl

type Vec3Impl struct {
	X float64
	Y float64
	Z float64
	R float64
	G float64
	B float64
}

Vec3Impl defines a vector with its position and colour.

func Add

func Add(v1 *Vec3Impl, args ...*Vec3Impl) *Vec3Impl

Add returns the sum of two or more vectors.

func Cross

func Cross(v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl

Cross computes the cross product of the two supplied vectors.

func DeNAN

func DeNAN(v *Vec3Impl) *Vec3Impl

DeNAN ensures that the vector elements are numbers.

func Div

func Div(v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl

Div returns the division of two vectors.

func Lerp

func Lerp(v0, v1 *Vec3Impl, t float64) *Vec3Impl

Lerp performs a linear interpolation between the two provided vectors.

func Max3

func Max3(v0 *Vec3Impl, v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl

Max3 returns a new vector with the maximum coordinates among the supplied ones.

func Min3

func Min3(v0 *Vec3Impl, v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl

Min3 returns a new vector with the minimum coordinates among the supplied ones.

func Mul

func Mul(v1 *Vec3Impl, v2 *Vec3Impl) *Vec3Impl

Mul returns the multiplication of two vectors.

func RandomCosineDirection

func RandomCosineDirection(random *fastrandom.LCG) *Vec3Impl

RandomCosineDirection returns a vector with a random cosine direction.

func RandomToSphere

func RandomToSphere(radius float64, distanceSquared float64, random *fastrandom.LCG) *Vec3Impl

RandomToSphere returns a new random sphere of the given radius at the given distance.

func ScalarDiv

func ScalarDiv(v1 *Vec3Impl, t float64) *Vec3Impl

ScalarMul returns the scalar division of the given vector and scalar values.

func ScalarMul

func ScalarMul(v1 *Vec3Impl, t float64) *Vec3Impl

ScalarMul returns the scalar multiplication of the given vector and scalar values.

func Sub

func Sub(v1 *Vec3Impl, args ...*Vec3Impl) *Vec3Impl

Sub returns the subtraction of two or more vectors.

func UnitVector

func UnitVector(v *Vec3Impl) *Vec3Impl

UnitVector returns a unit vector representation of the supplied vector.

func (*Vec3Impl) Length

func (v *Vec3Impl) Length() float64

Length returns the length of this vector.

func (*Vec3Impl) MakeUnitVector

func (v *Vec3Impl) MakeUnitVector()

MakeUnitVector transform the vector into its unit representation.

func (*Vec3Impl) SquaredLength

func (v *Vec3Impl) SquaredLength() float64

SquaredLength returns the squared length of this vector.