Skip to content

vanruesc/spatial-controls

Repository files navigation

Spatial Controls

CI Version

A movement controller for 3D objects and cameras that supports multiple control modes, smooth interpolation and configurable input settings.

Demo · Documentation

Installation

This library requires the peer dependency three.

npm install three spatial-controls

Usage

import { PerspectiveCamera } from "three"; import { SpatialControls } from "spatial-controls"; const camera = new PerspectiveCamera(...); const { position, quaternion } = camera; const domElement = document.getElementById("viewport"); const controls = new SpatialControls(position, quaternion, domElement); requestAnimationFrame(function render(timestamp) { requestAnimationFrame(render); controls.update(timestamp); });

Position, Target and Quaternion

The position, target and quaternion can be modified directly at any time. A subsequent update() call synchronizes the internal state of the controls. The quaternion has a higher priority than the target, meaning that changes to the quaternion will always set the target. The following methods are provided for convenience:

// Sets or replaces the position vector. controls.position.set(x, y, z); controls.position = otherPosition; // Sets or replaces the target vector. controls.target.set(x, y, z); controls.target = otherTarget; // Adjusts the target and the quaternion. controls.lookAt(x, y, z); controls.lookAt(target);

Settings

Configuration

import { Action, ControlMode, Input, PointerButton } from "spatial-controls"; const settings = controls.settings; settings.general.mode = ControlMode.THIRD_PERSON; settings.rotation.sensitivity = 2.2; settings.rotation.damping = 0.05; settings.translation.sensitivity = 0.25; settings.translation.damping = 0.1; settings.zoom.setRange(0.25, 3.0); settings.zoom.damping = 0.1; const keyBindings = settings.keyBindings; keyBindings.set("KeyR", Action.ROTATE); keyBindings.delete("KeyX"); // Input bindings also support modifiers. keyBindings.set(new Input<KeyCode>("Space", { modifiers: ["Ctrl"] }), Action.MOVE_DOWN); const pointerBindings = settings.pointerBindings; pointerBindings.delete(PointerButton.MAIN); pointerBindings.set(PointerButton.SECONDARY, Action.ROTATE); // The context menu can be disabled like this: document.body.addEventListener("contextmenu", e => e.preventDefault());

See the docs for more information.

Saving and Loading

// JSON round-trip. const json = JSON.stringify(settings); settings.fromJSON(json); // Via local storage. localStorage.setItem("spatial-controls", JSON.stringify(settings)); settings.fromJSON(localStorage.getItem("spatial-controls")); // Save as JSON file. const settingsURL = URL.createObjectURL(settings.toBlob()); const a = document.createElement("a"); a.setAttribute("href", settingsURL); a.setAttribute("download", "spatial-controls.json"); a.click(); URL.revokeObjectURL(settingsURL); // Load from JSON file. fetch("./spatial-controls.json") .then(response => response.text()) .then(data => settings.fromJSON(data)) .catch(e => console.error(e));

Constraints

Custom constraints can be applied to the position in 1st person mode and to the target in 3rd person mode.

const box = new Box3(); box.min.set(-1, -1, -1); box.max.set(1, 1, 1); const boxConstraint = (p: Vector3) => box.clampPoint(p, p); controls.constraints.add(boxConstraint); controls.constraints.delete(boxConstraint);

Contributing

Please refer to the contribution guidelines for details.

About

3D movement controls.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published