ThreeJS OrbitControls as a standalone and typescript compatible npm module (patched for TypeScript 2.3.4)


stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Feb 12, 2019Jul 12, 2018Minified + gzip package size for @kibou/three-orbitcontrols-ts in KB


This version of ThreeJS OrbitControls attempts to solve the issue with OrbitControls when using TypeScript : https://github.com/nicolaspanel/three-orbitcontrols-ts/issues/1 In short : 'Orbiting' works, but zoom and pan are both broken with the following message (I'm just showing the zoom one here): WARNING: OrbitControls.js encountered an unknown camera type - dolly/zoom disabled.

ThreeJS OrbitControls as a standalone and typescript compatible npm module.


npm install --save @kibou/three-orbitcontrols-ts


import * as THREE from 'three';
import { OrbitControls } from 'three-orbitcontrols-ts';

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;


All credit goes to OrbitControls.js contributors.

Works along with https://github.com/FranckVE/types-three

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.