commit	9fac4fce82197c3cce89363fef9c5d963db88aa2	[log] [tgz]
author	Oliver Sand <oliver.sand@tentaclelabs.com>	Fri Feb 07 12:26:27 2014 +0100
committer	Oliver Sand <oliver.sand@tentaclelabs.com>	Fri Feb 07 12:26:27 2014 +0100
tree	ac49eeb7a233dff35f3cd6548d3d1b1b50bc2cef
parent	5c206673fc4eee4d936cbb78d174381866dc8ba8 [diff]

tree: ac49eeb7a233dff35f3cd6548d3d1b1b50bc2cef

README.md

vector_math

Introduction

A Vector math library for 2D and 3D applications.

Features

2D,3D, and 4D vector and matrix types.
Quaternion type for animating rotations.
Collision detection: AABB, rays, spheres, ...
Flexible getters and setters, for example, position.xwz = color.grb;.
Fully documented.
Well tested.
Heavily optimized.

Libraries using vector_math

Getting Started

1. Add the following to your project's pubspec.yaml and run pub get.

dependencies:
  vector_math: any

If you want to stay on the latest developent version, add a dependency to the Git repository. You may also need to use it if another library uses the Git dependency.

dependencies:
  vector_math:
    git: https://github.com/johnmccutchan/vector_math.git

2. Add the correct import for your project.

import 'package:vector_math/vector_math.dart';

Documentation

Read the docs

Examples

1. Using the GLSL getter and setter syntax.

import 'package:vector_math/vector_math.dart';

void main() {
	Vector3 x = new Vector3.zero(); // Zero vector
	Vector4 y = new Vector4.splat(4.0); // Vector with 4.0 in all lanes
	x.zyx = y.xzz; // Sets z,y,x the values in x,z,z
}

2. Transforming a vector.

import 'dart:math';
import 'package:vector_math/vector_math.dart';

void main() {
	// Rotation of PI/2 degrees around the Y axis followed by a 
	// translation of (5.0, 2.0, 3.0).
	Matrix4 T = new Matrix4.rotationY(PI*0.5).translate(5.0, 2.0, 3.0);
	// A point.
	Vector3 position = new Vector3(1.0, 1.0, 1.0);
	// Transform position by T.
	T.transform3(position);
}

3. Invert a matrix

import 'dart:math';
import 'package:vector_math/vector_math.dart';

void main() {
	// Rotation of 90 degrees around the Y axis followed by a 
	// translation of (5.0, 2.0, 3.0).
	Matrix4 T = new Matrix4.rotationY(PI*0.5).translate(5.0, 2.0, 3.0);
	// Invert T.
	T.invert();
	// Invert just the rotation in T.
	T.invertRotation();
}

4. Rotate a vector using a quaternion

import 'dart:math';
import 'package:vector_math/vector_math.dart';

void main() {
	// The X axis.
	Vector3 axis = new Vector3(1.0, 0.0, 0.0);
	// 90 degrees.
	double angle = PI/2.0;
	// Quaternion encoding a 90 degree rotation along the X axis. 
	Quaternion q = new Quaternion.axisAngle(axis, angle);
	// A point.
	Vector3 point = new Vector3(1.0, 1.0, 1.0);
	// Rotate point by q.
	q.rotate(point);
}