Skip to content
bendou edited this page Jun 15, 2019 · 28 revisions

Welcome to meca3's wiki ! 😄

Main features

meca3 is a mechanics framework. It represents 3D euclidean space and allows :

  • Perform 3D affine space operations
  • Perform 3D geometrical transformations
  • Perform 3x3 matrix algebraical operations
  • Solve second order ODE
  • Manipulate trajectory of mobile
  • Generate trajectory from ODE solver
  • Move points according to a dynamic equation
  • Move points according to a dependent dynamic

Install

Install with the following command

npm install meca3

Use the provided modules with require

const Vector3 = require("meca3").Vector3;

Browser: the module is compatible with browser. Install the module and import each file as follows

<script src="path/to/meca3/Vector3.js"></script>

You can then use the modules in your browser js files.

Run unit tests

Unit testing is performed using mocha and chai frameworks. Install the framework and go to the test directory. Run the following command

npm test

Documentation

Each class of the module is documented here. The main features only are documented.

Take a look at the getting started page if you want a brief introduce to the module features.

Two complete examples of integration with three.js can be found here and here