You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
146 lines
4.8 KiB
146 lines
4.8 KiB
/*
|
|
* Copyright (C) 1998-2019 by Northwoods Software Corporation. All Rights Reserved.
|
|
*/
|
|
|
|
import * as go from '../release/go';
|
|
|
|
/**
|
|
* The PortShiftingTool class lets a user move a port on a {@link Node}.
|
|
*
|
|
* This tool only works when the Node has a port (any GraphObject) marked with
|
|
* a non-null and non-empty portId that is positioned in a Spot Panel,
|
|
* and the user holds down the Shift key.
|
|
* It works by modifying that port's {@link GraphObject#alignment} property.
|
|
*
|
|
* If you want to experiment with this extension, try the <a href="../../extensionsTS/PortShifting.html">Port Shifting</a> sample.
|
|
* @category Tool Extension
|
|
*/
|
|
export class PortShiftingTool extends go.Tool {
|
|
/**
|
|
* The port being shifted.
|
|
*/
|
|
public port: go.GraphObject | null = null;
|
|
private _originalAlignment: go.Spot = go.Spot.Default;
|
|
|
|
/**
|
|
* Constructs a PortShiftingTool and sets the name for the tool.
|
|
*/
|
|
constructor() {
|
|
super();
|
|
this.name = 'PortShifting';
|
|
}
|
|
|
|
/**
|
|
* This tool can only start if the mouse has moved enough so that it is not a click,
|
|
* and if the mouse down point is on a GraphObject "port" in a Spot Panel,
|
|
* as determined by {@link #findPort}.
|
|
*/
|
|
public canStart(): boolean {
|
|
const diagram = this.diagram;
|
|
if (!super.canStart()) return false;
|
|
// require left button & that it has moved far enough away from the mouse down point, so it isn't a click
|
|
const e = diagram.lastInput;
|
|
if (!e.left || !e.shift) return false;
|
|
if (!this.isBeyondDragSize()) return false;
|
|
|
|
return this.findPort() !== null;
|
|
}
|
|
|
|
/**
|
|
* From the {@link GraphObject} at the mouse point, search up the visual tree until we get to
|
|
* an object that has the {@link GraphObject#portId} property set to a non-empty string, that is in a Spot Panel,
|
|
* and that is not the main element of the panel (typically the first element).
|
|
* @return {GraphObject} This returns null if no such port is at the mouse down point.
|
|
*/
|
|
public findPort(): go.GraphObject | null {
|
|
const diagram = this.diagram;
|
|
const e = diagram.firstInput;
|
|
let elt = diagram.findObjectAt(e.documentPoint, null, null);
|
|
if (elt === null || !(elt.part instanceof go.Node)) return null;
|
|
|
|
while (elt !== null && elt.panel !== null) {
|
|
if (elt.panel.type === go.Panel.Spot && elt.panel.findMainElement() !== elt &&
|
|
elt.portId !== null && elt.portId !== '') return elt;
|
|
elt = elt.panel;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Start a transaction, call {@link #findPort} and remember it as the "port" property,
|
|
* and remember the original value for the port's {@link GraphObject#alignment} property.
|
|
*/
|
|
public doActivate(): void {
|
|
this.startTransaction('Shifted Label');
|
|
this.port = this.findPort();
|
|
if (this.port !== null) {
|
|
this._originalAlignment = this.port.alignment.copy();
|
|
}
|
|
super.doActivate();
|
|
}
|
|
|
|
/**
|
|
* Stop any ongoing transaction.
|
|
*/
|
|
public doDeactivate(): void {
|
|
super.doDeactivate();
|
|
this.stopTransaction();
|
|
}
|
|
|
|
/**
|
|
* Clear any reference to a port element.
|
|
*/
|
|
public doStop(): void {
|
|
this.port = null;
|
|
super.doStop();
|
|
}
|
|
|
|
/**
|
|
* Restore the port's original value for GraphObject.alignment.
|
|
*/
|
|
public doCancel(): void {
|
|
if (this.port !== null) {
|
|
this.port.alignment = this._originalAlignment;
|
|
}
|
|
super.doCancel();
|
|
}
|
|
|
|
/**
|
|
* During the drag, call {@link #updateAlignment} in order to set the {@link GraphObject#alignment} of the port.
|
|
*/
|
|
public doMouseMove(): void {
|
|
if (!this.isActive) return;
|
|
this.updateAlignment();
|
|
}
|
|
|
|
/**
|
|
* At the end of the drag, update the alignment of the port and finish the tool,
|
|
* completing a transaction.
|
|
*/
|
|
public doMouseUp(): void {
|
|
if (!this.isActive) return;
|
|
this.updateAlignment();
|
|
this.transactionResult = 'Shifted Label';
|
|
this.stopTool();
|
|
}
|
|
|
|
/**
|
|
* Save the port's {@link GraphObject#alignment} as a fractional Spot in the Spot Panel
|
|
* that the port is in. Thus if the main element changes size, the relative positions
|
|
* of the ports will be maintained. But that does assume that the port must remain
|
|
* inside the main element -- it cannot wander away from the node.
|
|
* This does not modify the port's {@link GraphObject#alignmentFocus} property.
|
|
*/
|
|
public updateAlignment(): void {
|
|
if (this.port === null || this.port.panel === null) return;
|
|
const last = this.diagram.lastInput.documentPoint;
|
|
const main = this.port.panel.findMainElement();
|
|
if (main === null) return;
|
|
const tl = main.getDocumentPoint(go.Spot.TopLeft);
|
|
const br = main.getDocumentPoint(go.Spot.BottomRight);
|
|
const x = Math.max(0, Math.min((last.x - tl.x) / (br.x - tl.x), 1));
|
|
const y = Math.max(0, Math.min((last.y - tl.y) / (br.y - tl.y), 1));
|
|
this.port.alignment = new go.Spot(x, y);
|
|
}
|
|
}
|