# @three-ts/orbit-controls

> Three.js OrbitControls typescript compatible package

Latest version **1.4.7** (published 2021-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @three-ts/orbit-controls
pnpm add @three-ts/orbit-controls
yarn add @three-ts/orbit-controls
bun add @three-ts/orbit-controls
```

## 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.4.7 |
| Published | 2021-03-03 |
| First published | 2021-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 60 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Alex Belov |
| Maintainers | ipritoflex |
| Keywords | orbit, controls, camera, typescript, controller, threejs, three, js |

## Links

- npm: https://www.npmjs.com/package/@three-ts/orbit-controls
- Repository: https://github.com/IPRIT/three-orbitcontrols-ts
- Homepage: https://github.com/IPRIT/three-orbitcontrols-ts#readme
- Issues: https://github.com/IPRIT/three-orbitcontrols-ts/issues
- npm.io page: https://npm.io/package/@three-ts/orbit-controls

## Dependencies (1)

- [three](https://npm.io/package/three.md) ^0.126.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.4.7 (latest) — 2021-03-03
- 1.4.6 — 2021-03-03
- 1.4.5 — 2021-03-02
- 1.4.4 — 2021-03-02
- 1.4.3 — 2021-03-02
- 1.4.2 — 2021-03-02
- 1.4.1 — 2021-03-02

## README

Three.js OrbitControls Typescript compatible package.

# Installation
```shell
npm install --save @three-ts/orbit-controls
```

# Usage
```js
import * as THREE from 'three';
import { OrbitControls } from '@three-ts/orbit-controls';

const camera = new THREE.SomeCamera(...);
const controls = new OrbitControls(camera, renderer.domElement);

// How far you can orbit vertically, upper and lower limits.
controls.minPolarAngle = 0;
controls.maxPolarAngle = Math.PI;


// How far you can dolly in and out ( PerspectiveCamera only )
controls.minDistance = 0;
controls.maxDistance = Infinity;

this.enableZoom = true; // Set to false to disable zooming
this.zoomSpeed = 1.0;


controls.enablePan = true; // Set to false to disable panning (ie vertical and horizontal translations)

controls.enableDamping = true; // Set to false to disable damping (ie inertia)
controls.dampingFactor = 0.25;
```

# Credit
All credit goes to [OrbitControls.js](https://github.com/mrdoob/three.js/blob/master/examples/js/controls/OrbitControls.js) contributors.

---
_Source: https://npm.io/package/@three-ts/orbit-controls · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._