src/tools/behaviors/drawTapBehavior.jsjavascript
import {TapBehavior} from './tapBehavior.js';
import {
isValidDrawPoint,
DrawPreview
} from './drawPreview.js';
/**
* @import {App} from '../../app/application.js';
* @import {LayerGroup} from '../../gui/layerGroup.js';
* @import {Point2D} from '../../math/point.js';
* @import {DrawSelect} from './drawSelect.js';
*/
/**
* Large tap budget when factory {@link ShapeFactory#getNPoints} is undefined.
*
* @type {number}
*/
const OPEN_ENDED_TAP_LIMIT = 65535;
/**
* Tap-driven placement session for {@link Draw}.
*/
export class DrawTapBehavior extends TapBehavior {
/**
* @type {Point2D|undefined}
*/
#lastMovePoint;
/**
* Layer group for the current placement preview/finalize path.
*
* @type {LayerGroup|undefined}
*/
#placementLayerGroup;
/**
* Draw preview.
*
* @type {DrawPreview}
*/
#drawPreview;
/**
* Draw select.
*
* @type {DrawSelect}
*/
#drawSelect;
/**
* @param {App} app The application.
* @param {DrawSelect} drawSelect Hepler for selecting and editing
* existing shapes.
*/
constructor(app, drawSelect) {
super();
this.#drawPreview = new DrawPreview(app);
this.#drawSelect = drawSelect;
}
/**
* @param {object} options Shape factory map (name → constructor).
*/
setOptions(options) {
this.#drawPreview.setOptions(options);
}
/**
* @param {object} features Live features (shape, colour, meta, …).
*/
setFeatures(features) {
this.#drawPreview.setFeatures(features);
this.#drawSelect.setFeatures(features);
}
/**
* @param {string} name Shape id.
* @returns {boolean} True if registered.
*/
hasShape(name) {
return this.#drawPreview.hasShape(name);
}
/**
* Try to select an existing shape at the pointer.
*
* @param {Point2D} point Display point.
* @param {LayerGroup} layerGroup Layer group.
* @returns {boolean} True if selection consumed the event.
*/
#trySelectShapeGroup(point, layerGroup) {
const drawLayer = layerGroup.getActiveDrawLayer();
if (typeof drawLayer !== 'undefined') {
// check can edit
if (!this.#drawSelect.checkCanEdit(drawLayer)) {
this.dispatchEvent(new CustomEvent('warn', {
detail: {
type: 'warn',
message: 'Cannot edit draw, data meta is invalid'
}
}));
return false;
}
// try to select
return this.#drawSelect.trySelectShapeGroup(point, drawLayer);
}
return false;
}
/**
* Apply the draw preview current shape number of points.
*/
#applyTapLimitFromFactory() {
const nPoints = this.#drawPreview.getNPoints();
if (typeof nPoints === 'undefined') {
super.setNumberOfTaps(OPEN_ENDED_TAP_LIMIT);
} else {
super.setNumberOfTaps(nPoints);
}
}
/**
* Clear temporary preview and tap session (Escape / cancel).
*/
resetPlacement() {
this.#drawPreview.resetPlacement();
super.onEnd();
}
/**
* Is the input point the last in the points list.
*
* @param {Point2D} point The point to check.
* @returns {boolean} True if equal to last.
*/
#isLastListPoint(point) {
const list = this.getPointList();
if (list.length > 0) {
const last = list[list.length - 1];
return last.equals(point);
}
return false;
}
/**
* Preview update while pointer moves during sticky placement.
*
* @param {Point2D} point Display point.
* @param {LayerGroup} layerGroup Layer group.
* @override
*/
onUpdate(point, layerGroup) {
if (!this.isActive()) {
return;
}
// exit if known point
if (this.#isLastListPoint(point)) {
return;
}
// exit if not valid
if (!isValidDrawPoint(point, layerGroup)) {
return;
}
this.#lastMovePoint = point;
this.#placementLayerGroup = layerGroup;
// update preview
const tmpPoints = this.getPointList();
tmpPoints.push(point);
this.#drawPreview.onNewPoints(tmpPoints, layerGroup);
}
/**
* @param {Point2D} point Display point.
* @param {LayerGroup} layerGroup Layer group.
* @override
*/
onTap(point, layerGroup) {
if (!this.isActive()) {
// shape selection
if (this.#trySelectShapeGroup(point, layerGroup)) {
return;
}
// shape creation
if (this.#drawPreview.tryBeginPlacement(layerGroup)) {
this.#drawSelect.disableAndResetEditor();
this.#applyTapLimitFromFactory();
} else {
const reason = this.#drawPreview.getCannotCreateReason(layerGroup);
this.dispatchEvent(new CustomEvent('warn', {
detail: {
type: 'warn',
message: `Cannot create draw, ${reason}`
}
}));
return;
}
}
// exit if known point
if (this.#isLastListPoint(point)) {
return;
}
// add point
this.#placementLayerGroup = layerGroup;
super.onTap(point, layerGroup);
// update preview
const tmpPoints = this.getPointList();
if (tmpPoints.length > 1) {
this.#drawPreview.onNewPoints(tmpPoints, layerGroup);
}
}
/**
* TapBehavior ends session — finalize fixed-count shapes or clear preview.
*
* @override
*/
onEnd() {
const pts = this.getPointList();
const lg = this.#placementLayerGroup;
const n = this.#drawPreview.getNPoints();
if (pts.length > 0 && lg) {
if (typeof n !== 'undefined') {
if (pts.length === n) {
// we have all points -> finish
this.#drawPreview.onFinalPoints(pts, lg);
} else if (pts.length === n - 1 &&
typeof this.#lastMovePoint !== 'undefined' &&
!this.#isLastListPoint(this.#lastMovePoint)) {
// one point missing -> finish with last move
// (for ex on mouse out)
pts.push(this.#lastMovePoint);
this.#drawPreview.onFinalPoints(pts, lg);
} else {
// missing points -> remove
this.#drawPreview.resetPlacement();
}
} else if (pts.length > 2) {
// undef npoints + some points -> finish
this.#drawPreview.onFinalPoints(pts, lg);
} else {
// undef npoints + not finished -> remove
this.#drawPreview.resetPlacement();
}
}
this.#lastMovePoint = undefined;
this.#placementLayerGroup = undefined;
super.onEnd();
}
}