mirror of
https://github.com/google/blockly.git
synced 2026-01-11 10:57:07 +01:00
51d9dad31f
* Reexport Blockly.utils.* modules from Blockly.utils * Update metadata (file sizes) again blockly_compressed.js has gotten too big for the second time this quarter. Update the expected file sizes for it so that tests will continue to pass.
135 lines
3.1 KiB
JavaScript
135 lines
3.1 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Utility methods for coordinate manipulation.
|
|
* These methods are not specific to Blockly, and could be factored out into
|
|
* a JavaScript framework such as Closure.
|
|
* @author fraser@google.com (Neil Fraser)
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* @name Blockly.utils.Coordinate
|
|
* @namespace
|
|
*/
|
|
goog.module('Blockly.utils.Coordinate');
|
|
|
|
/**
|
|
* Class for representing coordinates and positions.
|
|
* @param {number} x Left.
|
|
* @param {number} y Top.
|
|
* @struct
|
|
* @constructor
|
|
*/
|
|
const Coordinate = function(x, y) {
|
|
/**
|
|
* X-value
|
|
* @type {number}
|
|
*/
|
|
this.x = x;
|
|
|
|
/**
|
|
* Y-value
|
|
* @type {number}
|
|
*/
|
|
this.y = y;
|
|
};
|
|
|
|
/**
|
|
* Compares coordinates for equality.
|
|
* @param {?Coordinate} a A Coordinate.
|
|
* @param {?Coordinate} b A Coordinate.
|
|
* @return {boolean} True iff the coordinates are equal, or if both are null.
|
|
*/
|
|
Coordinate.equals = function(a, b) {
|
|
if (a == b) {
|
|
return true;
|
|
}
|
|
if (!a || !b) {
|
|
return false;
|
|
}
|
|
return a.x == b.x && a.y == b.y;
|
|
};
|
|
|
|
/**
|
|
* Returns the distance between two coordinates.
|
|
* @param {!Coordinate} a A Coordinate.
|
|
* @param {!Coordinate} b A Coordinate.
|
|
* @return {number} The distance between `a` and `b`.
|
|
*/
|
|
Coordinate.distance = function(a, b) {
|
|
const dx = a.x - b.x;
|
|
const dy = a.y - b.y;
|
|
return Math.sqrt(dx * dx + dy * dy);
|
|
};
|
|
|
|
/**
|
|
* Returns the magnitude of a coordinate.
|
|
* @param {!Coordinate} a A Coordinate.
|
|
* @return {number} The distance between the origin and `a`.
|
|
*/
|
|
Coordinate.magnitude = function(a) {
|
|
return Math.sqrt(a.x * a.x + a.y * a.y);
|
|
};
|
|
|
|
/**
|
|
* Returns the difference between two coordinates as a new
|
|
* Coordinate.
|
|
* @param {!Coordinate|!SVGPoint} a An x/y coordinate.
|
|
* @param {!Coordinate|!SVGPoint} b An x/y coordinate.
|
|
* @return {!Coordinate} A Coordinate representing the difference
|
|
* between `a` and `b`.
|
|
*/
|
|
Coordinate.difference = function(a, b) {
|
|
return new Coordinate(a.x - b.x, a.y - b.y);
|
|
};
|
|
|
|
/**
|
|
* Returns the sum of two coordinates as a new Coordinate.
|
|
* @param {!Coordinate|!SVGPoint} a An x/y coordinate.
|
|
* @param {!Coordinate|!SVGPoint} b An x/y coordinate.
|
|
* @return {!Coordinate} A Coordinate representing the sum of
|
|
* the two coordinates.
|
|
*/
|
|
Coordinate.sum = function(a, b) {
|
|
return new Coordinate(a.x + b.x, a.y + b.y);
|
|
};
|
|
|
|
/**
|
|
* Creates a new copy of this coordinate.
|
|
* @return {!Coordinate} A copy of this coordinate.
|
|
*/
|
|
Coordinate.prototype.clone = function() {
|
|
return new Coordinate(this.x, this.y);
|
|
};
|
|
|
|
/**
|
|
* Scales this coordinate by the given scale factor.
|
|
* @param {number} s The scale factor to use for both x and y dimensions.
|
|
* @return {!Coordinate} This coordinate after scaling.
|
|
*/
|
|
Coordinate.prototype.scale = function(s) {
|
|
this.x *= s;
|
|
this.y *= s;
|
|
return this;
|
|
};
|
|
|
|
/**
|
|
* Translates this coordinate by the given offsets.
|
|
* respectively.
|
|
* @param {number} tx The value to translate x by.
|
|
* @param {number} ty The value to translate y by.
|
|
* @return {!Coordinate} This coordinate after translating.
|
|
*/
|
|
Coordinate.prototype.translate = function(tx, ty) {
|
|
this.x += tx;
|
|
this.y += ty;
|
|
return this;
|
|
};
|
|
|
|
exports = Coordinate;
|