create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
651 lines (650 loc) • 26.5 kB
JavaScript
/*
* Copyright 1998-2025 by Northwoods Software Corporation. All Rights Reserved.
*/
/*
* This is an extension and not part of the main GoJS library.
* The source code for this is at extensionsJSM/GeometryReshapingTool.ts.
* Note that the API for this class may change with any version, even point releases.
* If you intend to use an extension in production, you should copy the code to your own source directory.
* Extensions can be found in the GoJS kit under the extensions or extensionsJSM folders.
* See the Extensions intro page (https://gojs.net/latest/intro/extensions.html) for more information.
*/
import * as go from 'gojs';
/**
* The GeometryReshapingTool class allows for a Shape's Geometry to be modified by the user
* via the dragging of tool handles.
* This does not handle Links, whose routes should be reshaped by the LinkReshapingTool.
* The {@link reshapeObjectName} needs to identify the named {@link go.Shape} within the
* selected {@link go.Part}.
* If the shape cannot be found or if its {@link go.Shape.geometry} is not of type {@link go.GeometryType.Path},
* this will not show any GeometryReshaping {@link go.Adornment}.
* At the current time this tool does not support adding or removing {@link go.PathSegment}s to the Geometry.
*
* If you want to experiment with this extension, try the <a href='../../samples/GeometryReshaping.html'>Geometry Reshaping</a> sample.
* @category Tool Extension
*/
export class GeometryReshapingTool extends go.Tool {
/**
* Constructs a GeometryReshapingTool and sets the handle and name of the tool.
*/
constructor(init) {
super();
this.name = 'GeometryReshaping';
let h = new go.Shape();
h.figure = 'Diamond';
h.desiredSize = new go.Size(8, 8);
h.fill = 'lightblue';
h.stroke = 'dodgerblue';
h.cursor = 'move';
this._handleArchetype = h;
h = new go.Shape();
h.figure = 'Circle';
h.desiredSize = new go.Size(7, 7);
h.fill = 'lightblue';
h.stroke = 'dodgerblue';
h.cursor = 'move';
this._midHandleArchetype = h;
this._isResegmenting = false;
this._resegmentingDistance = 3;
this._reshapeObjectName = 'SHAPE';
this._handle = null;
this._adornedShape = null;
this._originalGeometry = null;
if (init)
Object.assign(this, init);
}
/**
* A small GraphObject used as a reshape handle for each segment.
* The default GraphObject is a small blue diamond.
*/
get handleArchetype() {
return this._handleArchetype;
}
set handleArchetype(value) {
if (!(value instanceof go.GraphObject))
throw new Error('GeometryReshapingTool.handleArchetype must be a GraphObject');
this._handleArchetype = value;
}
/**
* A small GraphObject used as a reshape handle at the middle of each segment for inserting a new segment.
* The default GraphObject is a small blue circle.
*/
get midHandleArchetype() {
return this._midHandleArchetype;
}
set midHandleArchetype(value) {
if (!(value instanceof go.GraphObject))
throw new Error('GeometryReshapingTool.midHandleArchetype must be a GraphObject');
this._midHandleArchetype = value;
}
/**
* Gets or sets whether this tool supports the user's addition or removal of segments in the geometry.
* The default value is false.
* When the value is true, copies of the {@link midHandleArchetype} will appear in the middle of each segment.
* At the current time, resegmenting is limited to straight segments, not curved ones.
*/
get isResegmenting() {
return this._isResegmenting;
}
set isResegmenting(val) {
this._isResegmenting = !!val;
}
/**
* The maximum distance at which a resegmenting handle being positioned on a straight line
* between the adjacent points will cause one of the segments to be removed from the geometry.
* The default value is 3.
*/
get resegmentingDistance() {
return this._resegmentingDistance;
}
set resegmentingDistance(val) {
if (typeof val !== 'number')
throw new Error('GeometryReshapingTool.resegmentingDistance must be a number');
this._resegmentingDistance = val;
}
/**
* The name of the GraphObject to be reshaped.
* The default name is 'SHAPE'.
*/
get reshapeObjectName() {
return this._reshapeObjectName;
}
set reshapeObjectName(value) {
if (typeof value !== 'string')
throw new Error('GeometryReshapingTool.reshapeObjectName must be a string');
this._reshapeObjectName = value;
}
/**
* This read-only property returns the {@link go.GraphObject} that is the tool handle being dragged by the user.
* This will be contained by an {@link go.Adornment} whose category is 'GeometryReshaping'.
* Its {@link go.Adornment.adornedObject} is the same as the {@link adornedShape}.
*/
get handle() {
return this._handle;
}
set handle(val) {
if (val !== null && !(val instanceof go.GraphObject))
throw new Error('GeometryReshapingTool.handle must be a GraphObject');
this._handle = val;
}
/**
* Gets the {@link go.Shape} that is being reshaped.
* This must be contained within the selected Part.
*/
get adornedShape() {
return this._adornedShape;
}
/**
* This read-only property remembers the original value for {@link go.Shape.geometry},
* so that it can be restored if this tool is cancelled.
*/
get originalGeometry() {
return this._originalGeometry;
}
/**
* Show an {@link go.Adornment} with a reshape handle at each point of the geometry.
* Don't show anything if {@link reshapeObjectName} doesn't return a {@link go.Shape}
* that has a {@link go.Shape.geometry} of type {@link go.GeometryType.Path}.
*/
updateAdornments(part) {
if (part === null || part instanceof go.Link)
return; // this tool never applies to Links
if (part.isSelected && !this.diagram.isReadOnly) {
const selelt = part.findObject(this.reshapeObjectName);
if (selelt instanceof go.Shape &&
selelt.geometry !== null &&
selelt.actualBounds.isReal() &&
selelt.isVisibleObject() &&
part.canReshape() &&
part.actualBounds.isReal() &&
part.isVisible() &&
selelt.geometry.type === go.GeometryType.Path) {
const geo = selelt.geometry;
let adornment = part.findAdornment(this.name);
if (adornment === null || this._countHandles(geo) !== adornment.elements.count - 1) {
adornment = this.makeAdornment(selelt);
}
if (adornment !== null) {
// update the position/alignment of each handle
const b = geo.bounds;
// update the size of the adornment
const body = adornment.findObject('BODY');
if (body !== null)
body.desiredSize = b.size;
let unneeded = null;
const elts = adornment.elements;
for (let i = 0; i < elts.count; i++) {
const h = adornment.elt(i);
if (typeof h._typ !== 'number')
continue;
const typ = h._typ;
if (typeof h._fig !== 'number')
continue;
const figi = h._fig;
if (figi >= geo.figures.count) {
if (unneeded === null)
unneeded = [];
unneeded.push(h);
continue;
}
const fig = geo.figures.elt(figi);
if (typeof h._seg !== 'number')
continue;
const segi = h._seg;
if (segi >= fig.segments.count) {
if (unneeded === null)
unneeded = [];
unneeded.push(h);
continue;
}
const seg = fig.segments.elt(segi);
let x = 0;
let y = 0;
switch (typ) {
case 0:
x = fig.startX;
y = fig.startY;
break;
case 1:
x = seg.endX;
y = seg.endY;
break;
case 2:
x = seg.point1X;
y = seg.point1Y;
break;
case 3:
x = seg.point2X;
y = seg.point2Y;
break;
case 4:
x = (fig.startX + seg.endX) / 2;
y = (fig.startY + seg.endY) / 2;
break;
case 5:
x = (fig.segments.elt(segi - 1).endX + seg.endX) / 2;
y = (fig.segments.elt(segi - 1).endY + seg.endY) / 2;
break;
case 6:
x = (fig.startX + seg.endX) / 2;
y = (fig.startY + seg.endY) / 2;
break;
default:
throw new Error('unexpected handle type');
}
h.alignment = new go.Spot(0, 0, x - b.x, y - b.y);
}
if (unneeded !== null) {
unneeded.forEach((h) => {
if (adornment)
adornment.remove(h);
});
}
part.addAdornment(this.name, adornment);
adornment.location = selelt.getDocumentPoint(go.Spot.TopLeft);
adornment.angle = selelt.getDocumentAngle();
return;
}
}
}
part.removeAdornment(this.name);
}
/**
* @hidden @internal
*/
_countHandles(geo) {
const reseg = this.isResegmenting;
let c = 0;
geo.figures.each((fig) => {
c++;
fig.segments.each((seg) => {
if (reseg) {
if (seg.type === go.SegmentType.Line)
c++;
if (seg.isClosed)
c++;
}
c++;
if (seg.type === go.SegmentType.QuadraticBezier)
c++;
else if (seg.type === go.SegmentType.Bezier)
c += 2;
});
});
return c;
}
/**
* @hidden @internal
*/
makeAdornment(selelt) {
const adornment = new go.Adornment();
adornment.type = go.Panel.Spot;
adornment.locationObjectName = 'BODY';
adornment.locationSpot = new go.Spot(0, 0, -selelt.strokeWidth / 2, -selelt.strokeWidth / 2);
let h = new go.Shape();
h.name = 'BODY';
h.fill = null;
h.stroke = null;
h.strokeWidth = 0;
adornment.add(h);
const geo = selelt.geometry;
if (geo !== null) {
if (this.isResegmenting) {
for (let f = 0; f < geo.figures.count; f++) {
const fig = geo.figures.elt(f);
for (let g = 0; g < fig.segments.count; g++) {
const seg = fig.segments.elt(g);
let hnd;
if (seg.type === go.SegmentType.Line) {
hnd = this.makeResegmentHandle(selelt, fig, seg);
if (hnd !== null) {
hnd._typ = g === 0 ? 4 : 5;
hnd._fig = f;
hnd._seg = g;
adornment.add(hnd);
}
}
if (seg.isClosed) {
hnd = this.makeResegmentHandle(selelt, fig, seg);
if (hnd !== null) {
hnd._typ = 6;
hnd._fig = f;
hnd._seg = g;
adornment.add(hnd);
}
}
}
}
}
// requires Path Geometry, checked above in updateAdornments
for (let f = 0; f < geo.figures.count; f++) {
const fig = geo.figures.elt(f);
for (let g = 0; g < fig.segments.count; g++) {
const seg = fig.segments.elt(g);
if (g === 0) {
h = this.makeHandle(selelt, fig, seg);
if (h !== null) {
h._typ = 0;
h._fig = f;
h._seg = g;
adornment.add(h);
}
}
h = this.makeHandle(selelt, fig, seg);
if (h !== null) {
h._typ = 1;
h._fig = f;
h._seg = g;
adornment.add(h);
}
if (seg.type === go.SegmentType.QuadraticBezier || seg.type === go.SegmentType.Bezier) {
h = this.makeHandle(selelt, fig, seg);
if (h !== null) {
h._typ = 2;
h._fig = f;
h._seg = g;
adornment.add(h);
}
if (seg.type === go.SegmentType.Bezier) {
h = this.makeHandle(selelt, fig, seg);
if (h !== null) {
h._typ = 3;
h._fig = f;
h._seg = g;
adornment.add(h);
}
}
}
}
}
}
adornment.category = this.name;
adornment.adornedObject = selelt;
return adornment;
}
/**
* @hidden @internal
*/
makeHandle(selelt, fig, seg) {
const h = this.handleArchetype;
if (h === null)
return null;
return h.copy();
}
/**
* @hidden @internal
*/
makeResegmentHandle(pathshape, fig, seg) {
const h = this.midHandleArchetype;
if (h === null)
return null;
return h.copy();
}
/**
* This tool may run when there is a mouse-down event on a reshape handle.
*/
canStart() {
if (!this.isEnabled)
return false;
const diagram = this.diagram;
if (diagram.isReadOnly)
return false;
if (!diagram.allowReshape)
return false;
if (!diagram.lastInput.left)
return false;
const h = this.findToolHandleAt(diagram.firstInput.documentPoint, this.name);
return h !== null;
}
/**
* Start reshaping, if {@link findToolHandleAt} finds a reshape handle at the mouse down point.
*
* If successful this sets {@link handle} to be the reshape handle that it finds
* and {@link adornedShape} to be the {@link go.Shape} being reshaped.
* It also remembers the original geometry in case this tool is cancelled.
* And it starts a transaction.
*/
doActivate() {
const diagram = this.diagram;
if (diagram === null)
return;
this._handle = this.findToolHandleAt(diagram.firstInput.documentPoint, this.name);
const h = this._handle;
if (h === null)
return;
const shape = h.part.adornedObject;
if (!shape || !shape.part)
return;
this._adornedShape = shape;
diagram.isMouseCaptured = true;
this.startTransaction(this.name);
const typ = h._typ;
const figi = h._fig;
const segi = h._seg;
if (this.isResegmenting && typ >= 4 && shape.geometry !== null) {
const geo = shape.geometry.copy();
const fig = geo.figures.elt(figi);
const seg = fig.segments.elt(segi);
const newseg = seg.copy();
switch (typ) {
case 4: {
newseg.endX = (fig.startX + seg.endX) / 2;
newseg.endY = (fig.startY + seg.endY) / 2;
newseg.isClosed = false;
fig.segments.insertAt(segi, newseg);
break;
}
case 5: {
const prevseg = fig.segments.elt(segi - 1);
newseg.endX = (prevseg.endX + seg.endX) / 2;
newseg.endY = (prevseg.endY + seg.endY) / 2;
newseg.isClosed = false;
fig.segments.insertAt(segi, newseg);
break;
}
case 6: {
newseg.endX = (fig.startX + seg.endX) / 2;
newseg.endY = (fig.startY + seg.endY) / 2;
newseg.isClosed = seg.isClosed;
seg.isClosed = false;
fig.add(newseg);
break;
}
}
shape.geometry = geo; // modify the Shape
const part = shape.part;
part.ensureBounds();
this.updateAdornments(part); // update any Adornments of the Part
this._handle = this.findToolHandleAt(diagram.firstInput.documentPoint, this.name);
if (this._handle === null) {
this.doDeactivate(); // need to rollback the transaction and not set .isActive
return;
}
}
this._originalGeometry = shape.geometry;
this.isActive = true;
}
/**
* This stops the current reshaping operation with the Shape as it is.
*/
doDeactivate() {
this.stopTransaction();
this._handle = null;
this._adornedShape = null;
const diagram = this.diagram;
if (diagram !== null)
diagram.isMouseCaptured = false;
this.isActive = false;
}
/**
* Restore the shape to be the original geometry and stop this tool.
*/
doCancel() {
const shape = this._adornedShape;
if (shape !== null) {
// explicitly restore the original route, in case !UndoManager.isEnabled
shape.geometry = this._originalGeometry;
}
this.stopTool();
}
/**
* Call {@link reshape} with a new point determined by the mouse
* to change the geometry of the {@link adornedShape}.
*/
doMouseMove() {
const diagram = this.diagram;
if (this.isActive && diagram !== null) {
const newpt = this.computeReshape(diagram.lastInput.documentPoint);
this.reshape(newpt);
}
}
/**
* Reshape the Shape's geometry with a point based on the most recent mouse point by calling {@link reshape},
* and then stop this tool.
*/
doMouseUp() {
const diagram = this.diagram;
if (this.isActive && diagram !== null) {
const newpt = this.computeReshape(diagram.lastInput.documentPoint);
this.reshape(newpt);
const shape = this.adornedShape;
if (this.isResegmenting && shape && shape.geometry && shape.part) {
const typ = this.handle._typ;
const figi = this.handle._fig;
const segi = this.handle._seg;
const fig = shape.geometry.figures.elt(figi);
if (fig && fig.segments.count > 2) {
// avoid making a degenerate polygon
let ax;
let ay;
let bx;
let by;
let cx;
let cy;
if (typ === 0) {
const lastseg = fig.segments.length - 1;
ax = fig.segments.elt(lastseg).endX;
ay = fig.segments.elt(lastseg).endY;
bx = fig.startX;
by = fig.startY;
cx = fig.segments.elt(0).endX;
cy = fig.segments.elt(0).endY;
}
else {
if (segi <= 0) {
ax = fig.startX;
ay = fig.startY;
}
else {
ax = fig.segments.elt(segi - 1).endX;
ay = fig.segments.elt(segi - 1).endY;
}
bx = fig.segments.elt(segi).endX;
by = fig.segments.elt(segi).endY;
if (segi >= fig.segments.length - 1) {
cx = fig.startX;
cy = fig.startY;
}
else {
cx = fig.segments.elt(segi + 1).endX;
cy = fig.segments.elt(segi + 1).endY;
}
}
const q = new go.Point(bx, by);
q.projectOntoLineSegment(ax, ay, cx, cy);
// if B is within resegmentingDistance of the line from A to C,
// and if Q is between A and C, remove that point from the geometry
const dist = q.distanceSquaredPoint(new go.Point(bx, by));
if (dist < this.resegmentingDistance * this.resegmentingDistance) {
const geo = shape.geometry.copy();
const fg = geo.figures.elt(figi);
if (typ === 0) {
const first = fg.segments.first();
if (first) {
fg.startX = first.endX;
fg.startY = first.endY;
}
}
if (segi > 0) {
const prev = fg.segments.elt(segi - 1);
const seg = fg.segments.elt(segi);
prev.isClosed = seg.isClosed;
}
fg.segments.removeAt(segi);
shape.geometry = geo;
shape.part.removeAdornment(this.name);
this.updateAdornments(shape.part);
}
}
}
this.transactionResult = this.name; // success
}
this.stopTool();
}
/**
* Change the geometry of the {@link adornedShape} by moving the point corresponding to the current
* {@link handle} to be at the given {@link go.Point}.
* This is called by {@link doMouseMove} and {@link doMouseUp} with the result of calling
* {@link computeReshape} to constrain the input point.
* @param newPoint - the value of the call to {@link computeReshape}.
*/
reshape(newPoint) {
const shape = this.adornedShape;
if (shape === null || shape.geometry === null)
return;
const locpt = shape.getLocalPoint(newPoint);
const geo = shape.geometry.copy();
const h = this.handle;
if (!h)
return;
const type = h._typ;
if (type === undefined)
return;
if (h._fig >= geo.figures.count)
return;
const fig = geo.figures.elt(h._fig);
if (h._seg >= fig.segments.count)
return;
const seg = fig.segments.elt(h._seg);
switch (type) {
case 0:
fig.startX = locpt.x;
fig.startY = locpt.y;
break;
case 1:
seg.endX = locpt.x;
seg.endY = locpt.y;
break;
case 2:
seg.point1X = locpt.x;
seg.point1Y = locpt.y;
break;
case 3:
seg.point2X = locpt.x;
seg.point2Y = locpt.y;
break;
}
const offset = geo.normalize(); // avoid any negative coordinates in the geometry
shape.desiredSize = new go.Size(NaN, NaN); // clear the desiredSize so Geometry can determine size
shape.geometry = geo; // modify the Shape
const part = shape.part; // move the Part holding the Shape
if (part === null)
return;
part.ensureBounds();
if (offset.x !== 0 || offset.y !== 0) {
// support the whole Node being rotated
part.move(part.position.copy().subtract(offset.rotate(part.angle)));
}
this.updateAdornments(part); // update any Adornments of the Part
this.diagram.maybeUpdate(); // force more frequent drawing for smoother looking behavior
}
/**
* This is called by {@link doMouseMove} and {@link doMouseUp} to limit the input point
* before calling {@link reshape}.
* By default, this doesn't limit the input point.
* @param p - the point where the handle is being dragged.
*/
computeReshape(p) {
return p; // no constraints on the points
}
}