mirror of
https://github.com/google/blockly.git
synced 2026-01-07 09:00:11 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
60 lines
1.5 KiB
TypeScript
60 lines
1.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Utility methods for math.
|
|
* These methods are not specific to Blockly, and could be factored out into
|
|
* a JavaScript framework such as Closure.
|
|
*
|
|
* @namespace Blockly.utils.math
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.utils.math');
|
|
|
|
|
|
/**
|
|
* Converts degrees to radians.
|
|
* Copied from Closure's goog.math.toRadians.
|
|
*
|
|
* @param angleDegrees Angle in degrees.
|
|
* @returns Angle in radians.
|
|
* @alias Blockly.utils.math.toRadians
|
|
*/
|
|
export function toRadians(angleDegrees: number): number {
|
|
return angleDegrees * Math.PI / 180;
|
|
}
|
|
|
|
/**
|
|
* Converts radians to degrees.
|
|
* Copied from Closure's goog.math.toDegrees.
|
|
*
|
|
* @param angleRadians Angle in radians.
|
|
* @returns Angle in degrees.
|
|
* @alias Blockly.utils.math.toDegrees
|
|
*/
|
|
export function toDegrees(angleRadians: number): number {
|
|
return angleRadians * 180 / Math.PI;
|
|
}
|
|
|
|
/**
|
|
* Clamp the provided number between the lower bound and the upper bound.
|
|
*
|
|
* @param lowerBound The desired lower bound.
|
|
* @param number The number to clamp.
|
|
* @param upperBound The desired upper bound.
|
|
* @returns The clamped number.
|
|
* @alias Blockly.utils.math.clamp
|
|
*/
|
|
export function clamp(
|
|
lowerBound: number, number: number, upperBound: number): number {
|
|
if (upperBound < lowerBound) {
|
|
const temp = upperBound;
|
|
upperBound = lowerBound;
|
|
lowerBound = temp;
|
|
}
|
|
return Math.max(lowerBound, Math.min(number, upperBound));
|
|
}
|