@itwin/core-frontend
Version:
iTwin.js frontend components
88 lines • 5.24 kB
JavaScript
"use strict";
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module Tools
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ToolSettings = void 0;
const core_bentley_1 = require("@itwin/core-bentley");
const core_geometry_1 = require("@itwin/core-geometry");
/** Settings that control the behavior of built-in tools. Applications may modify these values.
* @public
* @extensions
*/
class ToolSettings {
/** Two tap must be within this period to be a double tap. */
static doubleTapTimeout = core_bentley_1.BeDuration.fromMilliseconds(250);
/** Two clicks must be within this period to be a double click. */
static doubleClickTimeout = core_bentley_1.BeDuration.fromMilliseconds(500);
/** Number of screen inches of movement allowed between clicks to still qualify as a double-click. */
static doubleClickToleranceInches = 0.05;
/** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */
static enableVirtualCursorForLocate = false;
/** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */
static preserveWorldUp = true;
/** Delay with a touch on the surface before a move operation begins. */
static touchMoveDelay = core_bentley_1.BeDuration.fromMilliseconds(50);
/** Delay with the mouse down before a drag operation begins. */
static startDragDelay = core_bentley_1.BeDuration.fromMilliseconds(110);
/** Distance in screen inches a touch point must move before being considered motion. */
static touchMoveDistanceInches = 0.1;
/** Distance in screen inches the cursor must move before a drag operation begins. */
static startDragDistanceInches = 0.15;
/** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */
static touchZoomChangeThresholdInches = 0.20;
/** Radius in screen inches to search for elements that anchor viewing operations. */
static viewToolPickRadiusInches = 0.20;
/** Camera angle enforced for walk tool. */
static walkCameraAngle = core_geometry_1.Angle.createDegrees(75.6);
/** Whether the walk tool enforces worldZ be aligned with screenY */
static walkEnforceZUp = false;
/** Speed, in meters per second, for the walk tool. */
static walkVelocity = 3.5;
/** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */
static walkVelocityChange = 0;
/** Whether the walk tool requests pointer lock to hide the cursor for mouse look */
static walkRequestPointerLock = true;
/** @beta Whether the look and move tool detects collisions while moving forward */
static walkCollisions = false;
/** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */
static walkDetectFloor = false;
/** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */
static walkStepHeight = 0.3;
/** @beta Camera height in meters above floor/ground to use for set up walk tool */
static walkEyeHeight = 1.6;
/** Scale factor applied for wheel events with "per-line" modifier. */
static wheelLineFactor = 40;
/** Scale factor applied for wheel events with "per-page" modifier. */
static wheelPageFactor = 120;
/** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it "bumps" through. */
static wheelZoomBumpDistance = core_geometry_1.Constant.oneCentimeter;
/** the speed to scroll for the "scroll view" tool (distance per second). */
static scrollSpeed = .75;
/** the speed to zoom for the "zoom view" tool. */
static zoomSpeed = 10;
/** Scale factor for zooming with mouse wheel. */
static wheelZoomRatio = 1.5;
/** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */
static viewingInertia = {
/** Flag to enable inertia. */
enabled: true,
/** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */
damping: .96,
/** Maximum duration of the inertia operation. Important when frame rates are low. */
duration: core_bentley_1.BeDuration.fromMilliseconds(500),
};
/** Maximum number of times in a second the accuSnap tool's onMotion function is called. */
static maxOnMotionSnapCallPerSecond = 15;
/** If true, drag box selection will accept spatial elements that are inside or overlap a clip volume instead of only what is visible in the view.
* @note Enabling is not recommended for web applications.
* @beta
*/
static enableVolumeSelection = false;
}
exports.ToolSettings = ToolSettings;
//# sourceMappingURL=ToolSettings.js.map