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
59 lines
1.5 KiB
TypeScript
59 lines
1.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Utility methods for rectangle manipulation.
|
|
* These methods are not specific to Blockly, and could be factored out into
|
|
* a JavaScript framework such as Closure.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.utils.Rect');
|
|
|
|
|
|
/**
|
|
* Class for representing rectangular regions.
|
|
*
|
|
* @alias Blockly.utils.Rect
|
|
*/
|
|
export class Rect {
|
|
/**
|
|
* @param top Top.
|
|
* @param bottom Bottom.
|
|
* @param left Left.
|
|
* @param right Right.
|
|
*/
|
|
constructor(
|
|
public top: number, public bottom: number, public left: number,
|
|
public right: number) {}
|
|
|
|
/**
|
|
* Tests whether this rectangle contains a x/y coordinate.
|
|
*
|
|
* @param x The x coordinate to test for containment.
|
|
* @param y The y coordinate to test for containment.
|
|
* @returns Whether this rectangle contains given coordinate.
|
|
*/
|
|
contains(x: number, y: number): boolean {
|
|
return x >= this.left && x <= this.right && y >= this.top &&
|
|
y <= this.bottom;
|
|
}
|
|
|
|
/**
|
|
* Tests whether this rectangle intersects the provided rectangle.
|
|
* Assumes that the coordinate system increases going down and left.
|
|
*
|
|
* @param other The other rectangle to check for intersection with.
|
|
* @returns Whether this rectangle intersects the provided rectangle.
|
|
*/
|
|
intersects(other: Rect): boolean {
|
|
return !(
|
|
this.left > other.right || this.right < other.left ||
|
|
this.top > other.bottom || this.bottom < other.top);
|
|
}
|
|
}
|