Files
blockly/core/renderers/measurables/input_connection.ts
Maribeth Bottorff 037eb59b89 chore: Lint TsDoc. (#6353)
* 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 commit d6d8656a45.

* 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 commit 173455588a.

* 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
2022-08-23 14:27:22 -07:00

65 lines
1.7 KiB
TypeScript

/**
* @license
* Copyright 2019 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* Class representing inputs with connections on a rendered block.
*
* @class
*/
import * as goog from '../../../closure/goog/goog.js';
goog.declareModuleId('Blockly.blockRendering.InputConnection');
import type {BlockSvg} from '../../block_svg.js';
import type {Input} from '../../input.js';
import type {RenderedConnection} from '../../rendered_connection.js';
import type {ConstantProvider} from '../common/constants.js';
import {Connection} from './connection.js';
import {Types} from './types.js';
/**
* The base class to represent an input that takes up space on a block
* during rendering
*
* @alias Blockly.blockRendering.InputConnection
*/
export class InputConnection extends Connection {
align: number;
connectedBlock: BlockSvg|null;
connectedBlockWidth: number;
connectedBlockHeight: number;
connectionOffsetX = 0;
connectionOffsetY = 0;
/**
* @param constants The rendering constants provider.
* @param input The input to measure and store information for.
* @internal
*/
constructor(constants: ConstantProvider, public input: Input) {
super(constants, input.connection as RenderedConnection);
this.type |= Types.INPUT;
this.align = input.align;
this.connectedBlock =
(input.connection && input.connection.targetBlock() ?
input.connection.targetBlock() as BlockSvg :
null);
if (this.connectedBlock) {
const bBox = this.connectedBlock.getHeightWidth();
this.connectedBlockWidth = bBox.width;
this.connectedBlockHeight = bBox.height;
} else {
this.connectedBlockWidth = 0;
this.connectedBlockHeight = 0;
}
}
}