vector_math 2.0.7

  • README.md
  • changelog.md
  • Installing
  • Versions
  • 98

vector_math

Build Status Coverage Status

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, ...
  • Utilities like color and common rendering related operations
  • 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

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.all(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);
}

5. Check if two axis aligned bounding boxes intersect

import 'package:vector_math/vector_math.dart';

void main() {
  // Define the first box with a minimum and a maximum.
  Aabb2 aabbOne = new Aabb2.minMax(new Vector2.zero(), new Vector2(4.0, 4.0));
  // Define the second box
  Aabb2 aabbTwo =
      new Aabb2.minMax(new Vector2(5.0, 5.0), new Vector2(6.0, 6.0));
  // Extend the second box to contain a point
  aabbTwo.hullPoint(new Vector2(3.0, 3.0));
  // Check if the two boxes intersect, returns true in this case.
  bool intersect = aabbOne.intersectsWithAabb2(aabbTwo);
}

6. Check where a ray and a sphere intersect

import 'package:vector_math/vector_math.dart';

void main() {
  // Define a ray starting at the origin and going into positive x-direction.
  Ray ray = new Ray.originDirection(new Vector3.zero(), new Vector3(1.0, 0.0, 0.0));
  // Defines a sphere with the center (5.0 0.0 0.0) and a radius of 2.
  Sphere sphere = new Sphere.centerRadius(new Vector3(5.0, 0.0, 0.0), 2.0);
  // Checks if the ray intersect with the sphere and returns the distance of the
  // intersection from the origin of the ray. Would return null if no intersection
  // is found.
  double distanceFromOrigin = ray.intersectsWithSphere(sphere);
  // Evaluate the position of the intersection, in this case (3.0 0.0 0.0).
  Vector3 position = ray.at(distanceFromOrigin);
}

7. Work with colors

import 'package:vector_math/vector_math.dart';

void main() {
  // Access a build-in color, colors are stored in 4-dimensional vectors.
  Vector4 red = Colors.red;
  Vector4 gray = new Vector4.zero();
  // Convert the red color to a grayscaled color.
  Colors.toGrayscale(red, gray);
  // Parse a blue color from a hex string.
  Vector4 blue = new Vector4.zero();
  Colors.fromHexString('#0000FF', blue);
  // Convert the blue color from RGB to HSL.
  Colors.rgbToHsl(blue, blue);
  // Reduce the lightness of the color by 50%.
  blue.z *= 0.5;
  // Convert the HSL color back to RGB.
  Colors.hslToRgb(blue, blue);
}

Development

To run test cases:

~/src/vector_math/> pub run test:test

To automatically generate the latest version of vector_math_64:

~/src/vector_math/> dart tool/generate_vector_math_64.dart

Changelog - vector_math

v 2.0.7 - April 2018

  • Fixed indexing bug in MeshGeometry.combine

v 2.0.6 - March 2018

  • Fixed angleTo for vectors that do not have unit length
  • Added Matrix4.tryInvert.

v 2.0.5 - July 2017

  • Strong mode clean

v 2.0.4 - February 2017

  • Added Matrix4.isIdentity()
  • Added Matrix4.isZero()
  • Added Matrix3.isIdentity()
  • Added Matrix3.isZero()
  • Added Vector2.angleTo and Vector2.angleToSigned

v 2.0.3 - May 2016

  • Synchronize Float64 version

v 2.0.2 - May 2016

  • Add Matrix4.leftTranslate

v 2.0.1 - April 2016

  • Add Matrix4.SkewX, Matrix4.SkewY, and Matrix4.Skew constructors

v 2.0.0 - March 2016

  • Remove call chaining, methods don't return this anymore. You can use the method cascade operator instead.
  • Remove dependency on quiver package

v 1.4.7 - February 2016

  • Fixed ArgumentError usage in Matrix4.inverted constructor

v 1.4.6 - January 2016

  • Added MatrixX.fromList constructor

v 1.4.5 - January 2016

  • Added Matrix4.inverted constructor

v 1.4.4 - December 2014

  • Updated dependencies.
  • Moved benchmark code into benchmark/
  • Updated vector_math_64.

v 1.4.3 - February 2014

  • Add color conversion routines (Contributed by Oliver Sand)
  • More collision and geometry routines (Contributed by Oliver Sand)
  • More tests (Contributed by Oliver Sand)
  • v 1.4.3 pub release

v 1.4.1 - January 2014

  • Better mesh generators (contributed by Brandon Jones)
  • Fix bug in ray v. triangle intersection test (contributed by @AMagill)

v 1.4.0 - November 2013

  • Add basic mesh generators (contributed by Brandon Jones)
  • Add more collision detection objects (contributed by Oliver Sand)

v 1.3.5 - July 2013

  • Class names now start with upper case, following Dart style guide.
  • Performance audit.
  • New vector_math_operations library.
  • New vector_math_lists library.
  • Added Aabb2 and fleshed out Aabb3 (thanks to Laszlo Korte)
  • Added Matrix solve methods (thanks to Laszlo Korte)
  • Added Methods needed for Three.dart (thanks to Anders Forsell)

v 1.1.0 - April 2013

  • Large refactoring.

v 0.9.7 - March 2013

  • Refactor generated constructor code into small functions.
  • Refactor generated operator* code into small functions.
  • Fix typo in quaternion code.

v 0.9.6 - March 2013

  • Update to latest String library.
  • Fix holding references in matrix constructor.
  • Replace double type with num in rotationY, and rotationZ.

v 0.9.5 - February 2013

  • Remove remaining double type tests and replace them with num.
  • Don't throw in the default matrix and vector constructors.

v 0.9.4 - February 2013

  • Remove unnecessary dart:scalarlist import.
  • Now that dart2js is fixed, rename negate_ back to negate.
  • Fix library imports in test suites.
  • Flexible constructor fix added to the generator.
  • Tested library under dart2js

v 0.9.3 - February 2013

  • Revert to using a single library!
  • Public API reverted to taking nums instead of doubles.
  • Fixed all warnings/errors introduced by M3.
  • drone.io integrated tests.
  • Fixed bug in rotation construction.
  • Fixed bug in orthographic matrix construction.
  • External contribution by fkleon fixing flexible constructors.
  • External contribution by donny-dont adding a missing cast .toDouble().

v 0.9.0 - October 2012

  • Pub: Dart Vector Math now fully supports the pub package management system!
  • API++: Minor changes to the API everywhere. The changes improve the aesthetics and performance of the library.
  • Faster: Lots of performance tweaks resulting in the library getting faster and generating less garbage.
  • 2D Cross Product: The Box2D Dart port requires a 2D cross product.
  • Library Split: Two libraries, one for browser applications and console applications.

v 0.8.5 - July 29 2012

  • 33% faster matrix matrix multiply
  • Fix generated operator[]=
  • Fix OpenGL lookat and perspective matrix constructors
  • Fix mat4x4 rotation constructors
  • Fix mat4x4 multiplied with vector3 not applying translation
  • Add utility methods for moving between Dart Vector Math types and Float32Array/Float32List types
  • Add mat4x4 translation constructor
  • Fixed buildPlaneVectors method
  • Fix mat4x4 transformDirect3 not applying translation
  • Add a new variant of mix() that takes the parameter t as a num or a vector
  • Large code reorganization to make it fit the 'dartblanklib' template

v 0.8.0 - June 10 2012

  • Inverse of 2x2,3x3,4x4 matrices
  • Inverse of upper 3x3 of a 4x4 matrix
  • Added zero, copy and raw specialized (and branchless) vector constructors
  • Added specialized copy matrix constructor
  • Added specialized rotation matrix constructors for mat2x2, mat3x3, and mat4x4
  • Added setRotation(num radians) to mat2x2
  • Added setRotationAround[x,y,z](num radians) to mat3x3 and mat4x4
  • Added buildPlaneVectors which constructs the spanning vectors given a plane normal
  • Added Adjoint of 2x2,3x3, and 4x4 matrices
  • Fixed many bugs in quaternion class
  • Fixed adjoint matrix code generation
  • Added selfAdd, selfSub, selfScale and selfNegate to matrix classes
  • Added serialization support for Float32Array and Vectors/Matrices

v 0.0.0 - March 20 2012

  • Initial release

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  vector_math: "^2.0.7"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:vector_math/vector_math.dart';
  
Version Uploaded Documentation Archive
2.0.7 Apr 25, 2018 Go to the documentation of vector_math 2.0.7 Download vector_math 2.0.7 archive
2.0.6 Mar 20, 2018 Go to the documentation of vector_math 2.0.6 Download vector_math 2.0.6 archive
2.0.5 Jul 6, 2017 Go to the documentation of vector_math 2.0.5 Download vector_math 2.0.5 archive
2.0.4 Feb 6, 2017 Go to the documentation of vector_math 2.0.4 Download vector_math 2.0.4 archive
2.0.3 May 17, 2016 Go to the documentation of vector_math 2.0.3 Download vector_math 2.0.3 archive
2.0.2 May 17, 2016 Go to the documentation of vector_math 2.0.2 Download vector_math 2.0.2 archive
2.0.1 Apr 25, 2016 Go to the documentation of vector_math 2.0.1 Download vector_math 2.0.1 archive
2.0.0 Mar 15, 2016 Go to the documentation of vector_math 2.0.0 Download vector_math 2.0.0 archive
1.4.7 Feb 1, 2016 Go to the documentation of vector_math 1.4.7 Download vector_math 1.4.7 archive
1.4.6 Jan 26, 2016 Go to the documentation of vector_math 1.4.6 Download vector_math 1.4.6 archive

All 30 versions...

Analysis

We analyzed this package on Jun 12, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.60.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
97 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
99 / 100
Overall score:
Weighted score of the above. [more]
98
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:vector_math/vector_math.dart.

Suggestions

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 74 hints.

    Strong-mode analysis of lib/src/vector_math/aabb2.dart gave the following hint:

    line: 45 col: 20
    'BYTES_PER_ELEMENT' is deprecated and shouldn't be used.

    Strong-mode analysis of lib/src/vector_math/aabb3.dart gave the following hint:

    line: 60 col: 20
    'BYTES_PER_ELEMENT' is deprecated and shouldn't be used.

    Similar analysis of the following files failed:

    • lib/src/vector_math/constants.dart (hint)
    • lib/src/vector_math/matrix4.dart (hint)
    • lib/src/vector_math/quaternion.dart (hint)
    • lib/src/vector_math/ray.dart (hint)
    • lib/src/vector_math/vector.dart (hint)
    • lib/src/vector_math/vector2.dart (hint)
    • lib/src/vector_math/vector3.dart (hint)
    • lib/src/vector_math/vector4.dart (hint)
    • lib/src/vector_math_64/aabb2.dart (hint)
    • lib/src/vector_math_64/aabb3.dart (hint)
    • lib/src/vector_math_64/constants.dart (hint)
    • lib/src/vector_math_64/matrix4.dart (hint)
    • lib/src/vector_math_64/quaternion.dart (hint)
    • lib/src/vector_math_64/ray.dart (hint)
    • lib/src/vector_math_64/vector.dart (hint)
    • lib/src/vector_math_64/vector2.dart (hint)
    • lib/src/vector_math_64/vector3.dart (hint)
    • lib/src/vector_math_64/vector4.dart (hint)
    • lib/src/vector_math_geometry/generators/circle_generator.dart (hint)
    • lib/src/vector_math_geometry/generators/cylinder_generator.dart (hint)
    • lib/src/vector_math_geometry/generators/ring_generator.dart (hint)
    • lib/src/vector_math_geometry/generators/sphere_generator.dart (hint)
    • lib/src/vector_math_geometry/mesh_geometry.dart (hint)
    • lib/src/vector_math_operations/matrix.dart (hint)
  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use vector_math.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.21.0 <2.0.0
Dev dependencies
benchmark_harness any
browser any
path >=1.0.0 <2.0.0
test >=0.12.0 <0.13.0