Class RotatingTool

The RotatingTool is used to interactively change the GraphObject#angle of a GraphObject. This tool allows the user to rotate the Part#rotateObject of the selected Part. Normally this works with Parts or Nodes; it does not make sense for Links. The Part must be Part#rotatable, which is false by default.

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(): RotatingTool

You do not normally need to create an instance of this tool because one already exists as the ToolManager#rotatingTool, which you can modify.

Returns

RotatingTool

Properties

public adornedObject: GraphObject

Gets the GraphObject that is being rotated.

public diagram: Diagram

Gets the Diagram that owns this tool and for which this tool is handling input events.

public handle: GraphObject

Gets or sets a small GraphObject that is copied as a rotation handle for the selected part.

public handleArchetype: GraphObject

Gets or sets a small GraphObject that is copied as a rotation handle for the selected part.

public isActive: boolean

Gets or sets whether this tool is started and is actively doing something.

public isEnabled: boolean

Gets or sets whether this tool can be started by a mouse event.

public name: string

Gets or sets the name of this tool.

public originalAngle: number

Gets the angle that was the original value of the GraphObject#angle of the GraphObject that is being rotated.

public snapAngleEpsilon: number

Gets or sets the the closeness to a desired angle at which the angle is "snapped to".

public snapAngleMultiple: number

Gets or sets the preferred angles for the selected object.

public transactionResult: string

Gets or sets the name of the transaction to be committed by #stopTransaction; if null, the transaction will be rolled back.

Methods

public canStart(): boolean

This tool may run when there is a mouse-down event on a rotate handle, the diagram is not read-only and it allows rotation, the left mouse button is being used, and this tool's adornment's rotate handle is at the current mouse point.

Returns

boolean

public cancelWaitAfter(): any

This is called to cancel any running "WaitAfter" timer.

Returns

any

public computeRotate(newPoint: Point): number

Compute the new angle given a point.

Parameters

Returns

number

public doActivate(): any

Capture the mouse, remember the original GraphObject#angle, and start a transaction.

Returns

any

public doCancel(): any

Restore the original GraphObject#angle of the adorned object.

Returns

any

public doDeactivate(): any

Stop the current transaction and release the mouse.

Returns

any

public doKeyDown(): any

The diagram will call this method upon a key down event.

Returns

any

public doKeyUp(): any

The diagram will call this method upon a key up event.

Returns

any

public doMouseDown(): any

The diagram will call this method upon a mouse down event.

Returns

any

public doMouseMove(): any

Call #rotate with a new angle determined by the current mouse point.

Returns

any

public doMouseUp(): any

Call #rotate with an angle based on the most recent mouse point, commit the transaction, and raise the "PartRotated" DiagramEvent.

Returns

any

public doMouseWheel(): any

The diagram will call this method as the mouse wheel is rotated.

Returns

any

public doStart(): any

This method is called by the diagram when this tool becomes the current tool; you should not call this method.

Returns

any

public doStop(): any

This method is called by the diagram when this tool stops being the current tool; you should not call this method.

Returns

any

public doWaitAfter(): any

This is called a certain delay after a call to #standardWaitAfter if there has not been any call to #cancelWaitAfter.

Returns

any

public findToolHandleAt(p: Point, category: string): GraphObject

This convenience function finds the front-most GraphObject that is at a given point and that is part of an Adornment that is of a given category.

Parameters

  • p: Point

    a Point in document coordinates.

  • category: string

    the required Part#category of the Adornment.

Returns

GraphObject

public isBeyondDragSize(first?: Point, last?: Point): boolean

Return true when the last mouse point is far enough away from the first mouse down point to constitute a drag operation instead of just a potential click.

Parameters

  • first?: Point optional

    Point in view coordinates, defaults to Diagram#firstInput's InputEvent#viewPoint.

  • last?: Point optional

    Point in view coordinates, defaults to Diagram#lastInput's InputEvent#viewPoint.

Returns

boolean

public rotate(newangle: number): any

Change the angle of the selected part's Part#rotateObject.

Parameters

  • newangle: number

Returns

any

public standardMouseClick(navig?: (obj: go.GraphObject) => go.GraphObject, pred?: (obj: go.GraphObject) => boolean): any

Implement the standard behavior for mouse clicks, searching for and calling click handler functions on GraphObjects or on Diagram, and raising the corresponding DiagramEvent.

Parameters

  • navig?: (obj: go.GraphObject) => go.GraphObject optional

    An optional custom navigation function to find target objects.

  • pred?: (obj: go.GraphObject) => boolean optional

    An optional custom predicate

Returns

any

public standardMouseOver(): any

Implement the standard behavior for mouse enter, over, and leave events, where the mouse is moving but no button is pressed.

Returns

any

public standardMouseSelect(): any

Implement the standard behavior for selecting parts with the mouse, depending on the control and shift modifier keys.

Returns

any

public standardMouseWheel(): any

Implement the standard behavior for mouse wheel events.

Returns

any

public standardWaitAfter(delay: number): any

This is called to start a new timer to call #doWaitAfter after a given delay.

Parameters

  • delay: number

    in milliseconds

Returns

any

public startTransaction(tname?: string): boolean

Call Diagram#startTransaction with the given transaction name.

Parameters

  • tname?: string optional

    a description of the transaction

Returns

boolean

public stopTool(): any

If the Diagram#currentTool is this tool, stop this tool and start the Diagram#defaultTool by making it be the new current tool.

Returns

any

public stopTransaction(): boolean

If #transactionResult is null, call Diagram#rollbackTransaction, otherwise call Diagram#commitTransaction.

Returns

boolean

public updateAdornments(part: Part): any

Show an Adornment with a rotate handle at a point to the side of the adorned object if the part is selected and visible and if Part#canRotate() is true.

Parameters

Returns

any