solver

Documentation

Overview

Package physics implements a basic physics engine.

Package physics implements a basic physics engine.

Index

• type GaussSeidel
  • func NewGaussSeidel() *GaussSeidel
  • func (gs *GaussSeidel) Reset(numBodies int)
  • func (gs *GaussSeidel) Solve(dt float32, nBodies int) *Solution
• type Solution
• type Solver
  • func (s *Solver) AddEquation(eq equation.EquationI)
  • func (s *Solver) ClearEquations()
  • func (s *Solver) RemoveEquation(eq equation.EquationI) bool
• type SolverI

Types

type GaussSeidel

type GaussSeidel struct {
	Solver
	// contains filtered or unexported fields
}

GaussSeidel equation solver. See https://en.wikipedia.org/wiki/Gauss-Seidel_method. The number of solver iterations determines the quality of the solution. More iterations yield a better solution but require more computation.

func NewGaussSeidel

func NewGaussSeidel() *GaussSeidel

NewGaussSeidel creates and returns a pointer to a new GaussSeidel constraint equation solver.

func (*GaussSeidel) Reset

func (gs *GaussSeidel) Reset(numBodies int)

func (*GaussSeidel) Solve

func (gs *GaussSeidel) Solve(dt float32, nBodies int) *Solution

Solve

type Solution

type Solution struct {
	VelocityDeltas        []math32.Vector3
	AngularVelocityDeltas []math32.Vector3
	Iterations            int
}

Solution represents a solver solution

type Solver

type Solver struct {
	Solution
	// contains filtered or unexported fields
}

Constraint equation solver base class.

func (*Solver) AddEquation

func (s *Solver) AddEquation(eq equation.EquationI)

AddEquation adds an equation to the solver.

func (*Solver) ClearEquations

func (s *Solver) ClearEquations()

ClearEquations removes all equations from the solver.

func (*Solver) RemoveEquation

func (s *Solver) RemoveEquation(eq equation.EquationI) bool

RemoveEquation removes the specified equation from the solver. Returns true if found, false otherwise.

type SolverI

type SolverI interface {
	Solve(dt float32, nBodies int) *Solution // Solve should return the number of iterations performed
	AddEquation(eq equation.EquationI)
	RemoveEquation(eq equation.EquationI) bool
	ClearEquations()
}

SolverI is the interface type for all constraint solvers.