Files
blockly/core/renderers/measurables/base.js
Aaron Dodson 1647a3299a fix: Move @alias onto classes instead of constructors (#6003)
* fix: Move @alias onto classes instead of constructors

* fix: Fix JSDoc for constructors.
2022-03-16 15:48:32 -07:00

65 lines
1.4 KiB
JavaScript

/**
* @license
* Copyright 2019 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Methods for graphically rendering a block as SVG.
*/
'use strict';
/**
* Methods for graphically rendering a block as SVG.
* @class
*/
goog.module('Blockly.blockRendering.Measurable');
/* eslint-disable-next-line no-unused-vars */
const {ConstantProvider} = goog.requireType('Blockly.blockRendering.ConstantProvider');
const {Types} = goog.require('Blockly.blockRendering.Types');
/**
* The base class to represent a part of a block that takes up space during
* rendering. The constructor for each non-spacer Measurable records the size
* of the block element (e.g. field, statement input).
* @alias Blockly.blockRendering.Measurable
*/
class Measurable {
/**
* @param {!ConstantProvider} constants The rendering
* constants provider.
* @package
*/
constructor(constants) {
/** @type {number} */
this.width = 0;
/** @type {number} */
this.height = 0;
/** @type {number} */
this.type = Types.NONE;
/** @type {number} */
this.xPos = 0;
/** @type {number} */
this.centerline = 0;
/**
* The renderer's constant provider.
* @type {!ConstantProvider}
* @protected
*/
this.constants_ = constants;
/** @type {number} */
this.notchOffset = this.constants_.NOTCH_OFFSET_LEFT;
}
}
exports.Measurable = Measurable;