Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@kibou/three-orbitcontrols-ts

itskibo152MIT0.2.8TypeScript support: included

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

orbit, controls, threejs, three, js, orbiter, camera, controller

readme

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.

Installation

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

Usage

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;

Credit

All credit goes to OrbitControls.js contributors.

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