# stewart-platform-simulator

> An npm package for simulating parallel motion mechanisms.

Latest version **1.0.1** (published 2022-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install stewart-platform-simulator
pnpm add stewart-platform-simulator
yarn add stewart-platform-simulator
bun add stewart-platform-simulator
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-08-04 |
| First published | 2022-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0 |
| Dependencies | 2 |
| Unpacked size | 40.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | David Young |
| Maintainers | dcyoung |
| Keywords | robotics |

## Links

- npm: https://www.npmjs.com/package/stewart-platform-simulator
- Repository: https://github.com/dcyoung/stewart-platform-simulator
- Homepage: https://github.com/dcyoung/stewart-platform-simulator#readme
- Issues: https://github.com/dcyoung/stewart-platform-simulator/issues
- npm.io page: https://npm.io/package/stewart-platform-simulator

## Dependencies (2)

- [three](https://npm.io/package/three.md) ^0.143.0
- [@types/three](https://npm.io/package/@types/three.md) ^0.143.0

## Recent versions

- 1.0.1 (latest) — 2022-08-04
- 1.0.0 — 2022-08-04

## README

# stewart-platform-simulator

An npm package for simulating parallel motion mechanisms.

## Install

```bash
npm install stewart-platform-simulator
```

## Usage

```ts
import { Ik, Mechanism, Simulation, Utils } from 'stewart-platform-simulator';

const parameters = new Mechanism.MechanismParameters3Dof();
const mechanism = new Mechanism.Mechanism3Dof(parameters);
const sim = new Simulation.HeadlessSimulation(mechanism);
requestAnimationFrame(() => sim.animateMechanism());

...
// Simulate random sinusoidal motion
sim.setSimulationMode(Simulation.SimulationMode.SIMULATE_MOTION);
...
// Simulate looking at a target position
sim.setSimulationMode(Simulation.SimulationMode.TRACK_TARGET);
sim.setTargetWorldPosition(new THREE.Vector3(...))

...
// Set to idle
sim.setSimulationMode(Simulation.SimulationMode.IDLE);
```

---
_Source: https://npm.io/package/stewart-platform-simulator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._