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.

210 lines
8.0 KiB

/*
* Copyright (C) 1998-2019 by Northwoods Software Corporation. All Rights Reserved.
*/
import * as go from '../release/go';
/**
* A class for simulating mouse and keyboard input.
*
* As a special hack, this supports limited simulation of drag-and-drop between Diagrams,
* by setting both the `sourceDiagram` and `targetDiagram` properties
* on the `eventprops` argument of the mouseDown/mouseMove/mouseUp methods.
* Although {@link InputEvent#targetDiagram} is a real property,
* the `sourceDiagram` property is only used by these Robot methods.
*
* If you want to experiment with this extension, try the <a href="../../extensionsTS/Robot.html">Simulating Input</a> sample.
* @category Extension
*/
export class Robot {
private _diagram: go.Diagram;
/**
* Construct a robot for a given {@link Diagram}. If none is provided, a new Diagram will be created.
*/
constructor(dia?: go.Diagram) {
if (dia instanceof go.Diagram) {
this._diagram = dia;
} else {
this._diagram = new go.Diagram();
}
}
/**
* Gets or sets the {@link Diagram} associated with this Robot.
*/
get diagram(): go.Diagram { return this._diagram; }
set diagram(val: go.Diagram) {
if (!(val instanceof go.Diagram)) throw new Error('Robot.diagram must be a Diagram, not: ' + val);
this._diagram = val;
}
/**
* @hidden @internal
* Transfer property settings from a JavaScript Object to an {@link InputEvent}.
*/
public initializeEvent(e: go.InputEvent, props?: go.ObjectData): void {
if (!props) return;
for (const p in props) {
if (p !== 'sourceDiagram') (e as any)[p] = (props as any)[p];
}
}
/**
* Simulate a mouse down event.
* @param {number} x the X-coordinate of the mouse point in document coordinates.
* @param {number} y the Y-coordinate of the mouse point in document coordinates.
* @param {number=} time the timestamp of the simulated event, in milliseconds; default zero
* @param {Object=} eventprops an optional argument providing properties for the InputEvent.
*/
public mouseDown(x: number, y: number, time?: number, eventprops?: go.ObjectData): void {
if (typeof x !== 'number' || typeof y !== 'number') throw new Error('Robot.mouseDown first two args must be X,Y numbers');
if (time === undefined) time = 0;
let diagram = this._diagram;
if (eventprops && (eventprops as any).sourceDiagram) diagram = (eventprops as any).sourceDiagram;
if (!diagram.isEnabled) return;
const n = new go.InputEvent();
n.diagram = diagram;
n.documentPoint = new go.Point(x, y);
n.viewPoint = diagram.transformDocToView(n.documentPoint);
n.timestamp = time;
n.down = true;
this.initializeEvent(n, eventprops);
diagram.lastInput = n;
diagram.firstInput = n.copy();
diagram.currentTool.doMouseDown();
}
/**
* Simulate a mouse move event.
* @param {number} x the X-coordinate of the mouse point in document coordinates.
* @param {number} y the Y-coordinate of the mouse point in document coordinates.
* @param {number=} time the timestamp of the simulated event, in milliseconds; default zero
* @param {Object=} eventprops an optional argument providing properties for the InputEvent.
*/
public mouseMove(x: number, y: number, time?: number, eventprops?: go.ObjectData): void {
if (typeof x !== 'number' || typeof y !== 'number') throw new Error('Robot.mouseMove first two args must be X,Y numbers');
if (time === undefined) time = 0;
let diagram = this._diagram;
if (eventprops && (eventprops as any).sourceDiagram) diagram = (eventprops as any).sourceDiagram;
if (!diagram.isEnabled) return;
const n = new go.InputEvent();
n.diagram = diagram;
n.documentPoint = new go.Point(x, y);
n.viewPoint = diagram.transformDocToView(n.documentPoint);
n.timestamp = time;
this.initializeEvent(n, eventprops);
diagram.lastInput = n;
diagram.currentTool.doMouseMove();
}
/**
* Simulate a mouse up event.
* @param {number} x the X-coordinate of the mouse point in document coordinates.
* @param {number} y the Y-coordinate of the mouse point in document coordinates.
* @param {number=} time the timestamp of the simulated event, in milliseconds; default zero
* @param {Object=} eventprops an optional argument providing properties for the InputEvent.
*/
public mouseUp(x: number, y: number, time?: number, eventprops?: go.ObjectData): void {
if (typeof x !== 'number' || typeof y !== 'number') throw new Error('Robot.mouseUp first two args must be X,Y numbers');
if (time === undefined) time = 0;
let diagram = this._diagram;
if (eventprops && (eventprops as any).sourceDiagram) diagram = (eventprops as any).sourceDiagram;
if (!diagram.isEnabled) return;
const n: go.InputEvent = new go.InputEvent();
n.diagram = diagram;
n.documentPoint = new go.Point(x, y);
n.viewPoint = diagram.transformDocToView(n.documentPoint);
n.timestamp = time;
n.up = true;
if (diagram.firstInput.documentPoint.equals(n.documentPoint)) n.clickCount = 1; // at least??
this.initializeEvent(n, eventprops);
diagram.lastInput = n;
// if (diagram.simulatedMouseUp(null, (n as any).sourceDiagram, n.documentPoint, n.targetDiagram)) return;
diagram.currentTool.doMouseUp();
}
/**
* Simulate a mouse wheel event.
* @param {number} delta non-zero turn
* @param {number=} time the timestamp of the simulated event, in milliseconds; default zero
* @param {Object=} eventprops an optional argument providing properties for the InputEvent.
*/
public mouseWheel(delta: number, time?: number, eventprops?: go.ObjectData): void {
if (typeof delta !== 'number') throw new Error('Robot.mouseWheel first arg must be DELTA number');
if (time === undefined) time = 0;
const diagram = this._diagram;
if (!diagram.isEnabled) return;
const n = diagram.lastInput.copy();
n.diagram = diagram;
n.delta = delta;
n.timestamp = time;
this.initializeEvent(n, eventprops);
diagram.lastInput = n;
diagram.currentTool.doMouseWheel();
}
/**
* Simulate a key down event.
* @param {string|number} keyorcode
* @param {number=} time the timestamp of the simulated event, in milliseconds; default zero
* @param {Object=} eventprops an optional argument providing properties for the InputEvent.
*/
public keyDown(keyorcode: string | number, time?: number, eventprops?: go.ObjectData): void {
if (typeof keyorcode !== 'string' && typeof keyorcode !== 'number') throw new Error('Robot.keyDown first arg must be a string or a number');
if (time === undefined) time = 0;
const diagram = this._diagram;
if (!diagram.isEnabled) return;
const n = diagram.lastInput.copy();
n.diagram = diagram;
if (typeof (keyorcode) === 'string') {
n.key = keyorcode;
} else if (typeof (keyorcode) === 'number') {
n.key = String.fromCharCode(keyorcode);
}
n.timestamp = time;
n.down = true;
this.initializeEvent(n, eventprops);
diagram.lastInput = n;
diagram.currentTool.doKeyDown();
}
/**
* Simulate a key up event.
* @param {string|number} keyorcode
* @param {number=} time the timestamp of the simulated event, in milliseconds; default zero
* @param {Object=} eventprops an optional argument providing properties for the InputEvent.
*/
public keyUp(keyorcode: string | number, time?: number, eventprops?: go.ObjectData): void {
if (typeof keyorcode !== 'string' && typeof keyorcode !== 'number') throw new Error('Robot.keyUp first arg must be a string or a number');
if (time === undefined) time = 0;
const diagram = this._diagram;
if (!diagram.isEnabled) return;
const n = diagram.lastInput.copy();
n.diagram = diagram;
if (typeof (keyorcode) === 'string') {
n.key = keyorcode;
} else if (typeof (keyorcode) === 'number') {
n.key = String.fromCharCode(keyorcode);
}
n.timestamp = time;
n.up = true;
this.initializeEvent(n, eventprops);
diagram.lastInput = n;
diagram.currentTool.doKeyUp();
}
}