Browse Source

OrbitControls: constants

Guilherme Avila 6 years ago
parent
commit
f27cb02d91

+ 5 - 5
docs/examples/en/controls/OrbitControls.html

@@ -190,9 +190,9 @@ controls.keys = {
 			This object contains references to the mouse actions used by the controls.
 			<code>
 controls.mouseButtons = {
-	LEFT: THREE.MOUSE.ROTATE,
-	MIDDLE: THREE.MOUSE.DOLLY,
-	RIGHT: THREE.MOUSE.PAN
+	LEFT: THREE.OrbitControls.CLICK.ROTATE,
+	MIDDLE: THREE.OrbitControls.CLICK.DOLLY,
+	RIGHT: THREE.OrbitControls.CLICK.PAN
 }
 			</code>
 		</p>
@@ -239,8 +239,8 @@ controls.mouseButtons = {
 			This object contains references to the touch actions used by the controls.
 			<code>
 controls.touches = {
-	ONE: THREE.TOUCH.ROTATE,
-	TWO: THREE.TOUCH.DOLLY_PAN
+	ONE: THREE.OrbitControls.TOUCH.ROTATE,
+	TWO: THREE.OrbitControls.TOUCH.DOLLY_PAN
 }
 			</code>
 		</p>

+ 18 - 15
examples/js/controls/OrbitControls.js

@@ -76,10 +76,10 @@ THREE.OrbitControls = function ( object, domElement ) {
 	this.keys = { LEFT: 37, UP: 38, RIGHT: 39, BOTTOM: 40 };
 
 	// Mouse buttons
-	this.mouseButtons = { LEFT: THREE.MOUSE.ROTATE, MIDDLE: THREE.MOUSE.DOLLY, RIGHT: THREE.MOUSE.PAN };
+	this.mouseButtons = { LEFT: THREE.OrbitControls.CLICK.ROTATE, MIDDLE: THREE.OrbitControls.CLICK.DOLLY, RIGHT: THREE.OrbitControls.CLICK.PAN };
 
 	// Touch fingers
-	this.touches = { ONE: THREE.TOUCH.ROTATE, TWO: THREE.TOUCH.DOLLY_PAN };
+	this.touches = { ONE: THREE.OrbitControls.TOUCH.ROTATE, TWO: THREE.OrbitControls.TOUCH.DOLLY_PAN };
 
 	// for reset
 	this.target0 = this.target.clone();
@@ -791,7 +791,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.mouseButtons.LEFT ) {
 
-					case THREE.MOUSE.ROTATE:
+					case THREE.OrbitControls.CLICK.ROTATE:
 
 						if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
 
@@ -813,7 +813,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case THREE.MOUSE.PAN:
+					case THREE.OrbitControls.CLICK.PAN:
 
 						if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
 
@@ -848,7 +848,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.mouseButtons.MIDDLE ) {
 
-					case THREE.MOUSE.DOLLY:
+					case THREE.OrbitControls.CLICK.DOLLY:
 
 						if ( scope.enableZoom === false ) return;
 
@@ -871,7 +871,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.mouseButtons.RIGHT ) {
 
-					case THREE.MOUSE.ROTATE:
+					case THREE.OrbitControls.CLICK.ROTATE:
 
 						if ( scope.enableRotate === false ) return;
 
@@ -881,7 +881,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case THREE.MOUSE.PAN:
+					case THREE.OrbitControls.CLICK.PAN:
 
 						if ( scope.enablePan === false ) return;
 
@@ -998,7 +998,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.touches.ONE ) {
 
-					case TOUCH.ROTATE:
+					case THREE.OrbitControls.TOUCH.ROTATE:
 
 						if ( scope.enableRotate === false ) return;
 
@@ -1008,7 +1008,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case TOUCH.PAN:
+					case THREE.OrbitControls.TOUCH.PAN:
 
 						if ( scope.enablePan === false ) return;
 
@@ -1030,7 +1030,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.touches.TWO ) {
 
-					case TOUCH.DOLLY_PAN:
+					case THREE.OrbitControls.TOUCH.DOLLY_PAN:
 
 						if ( scope.enableZoom === false && scope.enablePan === false ) return;
 
@@ -1040,7 +1040,7 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case TOUCH.DOLLY_ROTATE:
+					case THREE.OrbitControls.TOUCH.DOLLY_ROTATE:
 
 						if ( scope.enableZoom === false && scope.enableRotate === false ) return;
 
@@ -1168,6 +1168,9 @@ THREE.OrbitControls = function ( object, domElement ) {
 
 };
 
+THREE.OrbitControls.CLICK = { ROTATE: 0, DOLLY: 1, PAN: 2 };
+THREE.OrbitControls.TOUCH = { ROTATE: 0, PAN: 1, DOLLY_PAN: 2, DOLLY_ROTATE: 3 };
+
 THREE.OrbitControls.prototype = Object.create( THREE.EventDispatcher.prototype );
 THREE.OrbitControls.prototype.constructor = THREE.OrbitControls;
 
@@ -1308,11 +1311,11 @@ THREE.MapControls = function ( object, domElement ) {
 
 	THREE.OrbitControls.call( this, object, domElement );
 
-	this.mouseButtons.LEFT = THREE.MOUSE.PAN;
-	this.mouseButtons.RIGHT = THREE.MOUSE.ROTATE;
+	this.mouseButtons.LEFT = THREE.OrbitControls.CLICK.PAN;
+	this.mouseButtons.RIGHT = THREE.OrbitControls.CLICK.ROTATE;
 
-	this.touches.ONE = THREE.TOUCH.PAN;
-	this.touches.TWO = THREE.TOUCH.DOLLY_ROTATE;
+	this.touches.ONE = THREE.OrbitControls.TOUCH.PAN;
+	this.touches.TWO = THREE.OrbitControls.TOUCH.DOLLY_ROTATE;
 
 }
 

+ 18 - 5
examples/jsm/controls/OrbitControls.d.ts

@@ -1,4 +1,4 @@
-import { Camera, MOUSE, Object3D, TOUCH, Vector3 } from '../../../src/Three';
+import { Camera, Object3D, Vector3 } from '../../../src/Three';
 
 export class OrbitControls {
 	constructor(object: Camera, domElement?: HTMLElement);
@@ -44,8 +44,21 @@ export class OrbitControls {
 
 	enableKeys: boolean;
 	keys: { LEFT: number; UP: number; RIGHT: number; BOTTOM: number; };
-	mouseButtons: { LEFT: MOUSE; MIDDLE: MOUSE; RIGHT: MOUSE;  };
-	touches: { ONE: TOUCH; TWO: TOUCH };
+	mouseButtons: { LEFT: number; MIDDLE: number; RIGHT: number;  };
+	touches: { ONE: number; TWO: number };
+
+	static CLICK: {
+		ROTATE: number;
+		DOLLY: number;
+		PAN: number;
+	};
+
+	static TOUCH: {
+		ROTATE: number;
+		PAN: number;
+		DOLLY_PAN: number;
+		DOLLY_ROTATE: number;
+	};
 
 	rotateLeft(angle?: number): void;
 
@@ -125,8 +138,8 @@ export class MapControls {
 
 	enableKeys: boolean;
 	keys: { LEFT: number; UP: number; RIGHT: number; BOTTOM: number; };
-	mouseButtons: { LEFT: MOUSE; MIDDLE: MOUSE; RIGHT: MOUSE;  };
-	touches: { ONE: TOUCH; TWO: TOUCH };
+	mouseButtons: { LEFT: number; MIDDLE: number; RIGHT: number;  };
+	touches: { ONE: number; TWO: number };
 
 	rotateLeft(angle?: number): void;
 

+ 18 - 17
examples/jsm/controls/OrbitControls.js

@@ -9,10 +9,8 @@
 
 import {
 	EventDispatcher,
-	MOUSE,
 	Quaternion,
 	Spherical,
-	TOUCH,
 	Vector2,
 	Vector3
 } from "../../../build/three.module.js";
@@ -86,10 +84,10 @@ var OrbitControls = function ( object, domElement ) {
 	this.keys = { LEFT: 37, UP: 38, RIGHT: 39, BOTTOM: 40 };
 
 	// Mouse buttons
-	this.mouseButtons = { LEFT: MOUSE.ROTATE, MIDDLE: MOUSE.DOLLY, RIGHT: MOUSE.PAN };
+	this.mouseButtons = { LEFT: OrbitControls.CLICK.ROTATE, MIDDLE: OrbitControls.CLICK.DOLLY, RIGHT: OrbitControls.CLICK.PAN };
 
 	// Touch fingers
-	this.touches = { ONE: TOUCH.ROTATE, TWO: TOUCH.DOLLY_PAN };
+	this.touches = { ONE: OrbitControls.TOUCH.ROTATE, TWO: OrbitControls.TOUCH.DOLLY_PAN };
 
 	// for reset
 	this.target0 = this.target.clone();
@@ -801,7 +799,7 @@ var OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.mouseButtons.LEFT ) {
 
-					case MOUSE.ROTATE:
+					case OrbitControls.CLICK.ROTATE:
 
 						if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
 
@@ -823,7 +821,7 @@ var OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case MOUSE.PAN:
+					case OrbitControls.CLICK.PAN:
 
 						if ( event.ctrlKey || event.metaKey || event.shiftKey ) {
 
@@ -858,7 +856,7 @@ var OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.mouseButtons.MIDDLE ) {
 
-					case MOUSE.DOLLY:
+					case OrbitControls.CLICK.DOLLY:
 
 						if ( scope.enableZoom === false ) return;
 
@@ -881,7 +879,7 @@ var OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.mouseButtons.RIGHT ) {
 
-					case MOUSE.ROTATE:
+					case OrbitControls.CLICK.ROTATE:
 
 						if ( scope.enableRotate === false ) return;
 
@@ -891,7 +889,7 @@ var OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case MOUSE.PAN:
+					case OrbitControls.CLICK.PAN:
 
 						if ( scope.enablePan === false ) return;
 
@@ -1008,7 +1006,7 @@ var OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.touches.ONE ) {
 
-					case TOUCH.ROTATE:
+					case OrbitControls.TOUCH.ROTATE:
 
 						if ( scope.enableRotate === false ) return;
 
@@ -1018,7 +1016,7 @@ var OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case TOUCH.PAN:
+					case OrbitControls.TOUCH.PAN:
 
 						if ( scope.enablePan === false ) return;
 
@@ -1040,7 +1038,7 @@ var OrbitControls = function ( object, domElement ) {
 
 				switch ( scope.touches.TWO ) {
 
-					case TOUCH.DOLLY_PAN:
+					case OrbitControls.TOUCH.DOLLY_PAN:
 
 						if ( scope.enableZoom === false && scope.enablePan === false ) return;
 
@@ -1050,7 +1048,7 @@ var OrbitControls = function ( object, domElement ) {
 
 						break;
 
-					case TOUCH.DOLLY_ROTATE:
+					case OrbitControls.TOUCH.DOLLY_ROTATE:
 
 						if ( scope.enableZoom === false && scope.enableRotate === false ) return;
 
@@ -1178,6 +1176,9 @@ var OrbitControls = function ( object, domElement ) {
 
 };
 
+OrbitControls.CLICK = { ROTATE: 0, DOLLY: 1, PAN: 2 };
+OrbitControls.TOUCH = { ROTATE: 0, PAN: 1, DOLLY_PAN: 2, DOLLY_ROTATE: 3 };
+
 OrbitControls.prototype = Object.create( EventDispatcher.prototype );
 OrbitControls.prototype.constructor = OrbitControls;
 
@@ -1318,11 +1319,11 @@ var MapControls = function ( object, domElement ) {
 
 	OrbitControls.call( this, object, domElement );
 
-	this.mouseButtons.LEFT = MOUSE.PAN;
-	this.mouseButtons.RIGHT = MOUSE.ROTATE;
+	this.mouseButtons.LEFT = OrbitControls.CLICK.PAN;
+	this.mouseButtons.RIGHT = OrbitControls.CLICK.ROTATE;
 
-	this.touches.ONE = TOUCH.PAN;
-	this.touches.TWO = TOUCH.DOLLY_ROTATE;
+	this.touches.ONE = OrbitControls.TOUCH.PAN;
+	this.touches.TWO = OrbitControls.TOUCH.DOLLY_ROTATE;
 
 }
 

+ 0 - 10
src/constants.d.ts

@@ -5,16 +5,6 @@ export enum MOUSE {
 	LEFT,
 	MIDDLE,
 	RIGHT,
-	ROTATE,
-	DOLLY,
-	PAN,
-}
-
-export enum TOUCH {
-	ROTATE,
-	PAN,
-	DOLLY_PAN,
-	DOLLY_ROTATE,
 }
 
 // GL STATE CONSTANTS

+ 1 - 2
src/constants.js

@@ -1,6 +1,5 @@
 export var REVISION = '106';
-export var MOUSE = { LEFT: 0, MIDDLE: 1, RIGHT: 2, ROTATE: 0, DOLLY: 1, PAN: 2 };
-export var TOUCH = { ROTATE: 0, PAN: 1, DOLLY_PAN: 2, DOLLY_ROTATE: 3 };
+export var MOUSE = { LEFT: 0, MIDDLE: 1, RIGHT: 2 };
 export var CullFaceNone = 0;
 export var CullFaceBack = 1;
 export var CullFaceFront = 2;

+ 1 - 2
test/unit/src/constants.tests.js

@@ -9,8 +9,7 @@ export default QUnit.module( 'Constants', () => {
 
 	QUnit.test( "default values", ( assert ) => {
 
-		assert.propEqual( Constants.MOUSE, { LEFT: 0, MIDDLE: 1, RIGHT: 2, ROTATE: 0, DOLLY: 1, PAN: 2 }, 'MOUSE equal { LEFT: 0, MIDDLE: 1, RIGHT: 2, ROTATE: 0, DOLLY: 1, PAN: 2 }' );
-		assert.propEqual( Constants.TOUCH, { ROTATE: 0, PAN: 1, DOLLY_PAN: 2, DOLLY_ROTATE: 3 }, 'TOUCH equal { ROTATE: 0, PAN: 1, DOLLY_PAN: 2, DOLLY_ROTATE: 3 }' );
+		assert.propEqual( Constants.MOUSE, { LEFT: 0, MIDDLE: 1, RIGHT: 2 }, 'MOUSE equal { LEFT: 0, MIDDLE: 1, RIGHT: 2 }' );
 		assert.equal( Constants.CullFaceNone, 0, 'CullFaceNone equal 0' );
 		assert.equal( Constants.CullFaceBack, 1, 'CullFaceBack equal 1' );
 		assert.equal( Constants.CullFaceFront, 2, 'CullFaceFront is equal to 2' );