Sprotty
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Class. Bezier Edge Router

applyHandleMoves()

applyHandleMoves(edge, moves): void

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:156

Updates the routing points and handles of the given edge with regard to the given moves.

Parameters

edge

SRoutableElementImpl

moves

ResolvedHandleMove[]

Returns

void

Overrides

AbstractEdgeRouter.applyHandleMoves


applyInnerHandleMoves()

protected applyInnerHandleMoves(edge, moves): void

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:228

Parameters

edge

SRoutableElementImpl

moves

ResolvedHandleMove[]

Returns

void

Overrides

AbstractEdgeRouter.applyInnerHandleMoves


applyReconnect()

applyReconnect(edge, newSourceId?, newTargetId?): void

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:316

Updates the routing points and handles of the given edge with regard to the given moves.

Parameters

edge

SRoutableElementImpl

newSourceId?

string

newTargetId?

string

Returns

void

Inherited from

AbstractEdgeRouter.applyReconnect


applySnapshot()

applySnapshot(edge, snapshot): void

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:375

Applies a snapshot to the current edge.

Parameters

edge

SRoutableElementImpl

snapshot

EdgeSnapshot

Returns

void

Inherited from

AbstractEdgeRouter.applySnapshot


calculateDefaultCorners()

protected calculateDefaultCorners(edge, sourceAnchors, targetAnchors, options): Point[]

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:389

Parameters

edge

SRoutableElementImpl

sourceAnchors

DefaultAnchors

targetAnchors

DefaultAnchors

options

LinearRouteOptions

Returns

Point[]

Inherited from

AbstractEdgeRouter.calculateDefaultCorners


calculateSegment()

protected calculateSegment(edge, t): undefined | { lambda: number; segmentEnd: Point; segmentStart: Point; }

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:145

Parameters

edge

SRoutableElementImpl

t

number

Returns

undefined | { lambda: number; segmentEnd: Point; segmentStart: Point; }

Inherited from

AbstractEdgeRouter.calculateSegment


cleanupRoutingPoints()

cleanupRoutingPoints(edge, routingPoints, updateHandles, addRoutingPoints): void

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:284

Remove/add points in order to keep routing constraints consistent, or reset RPs on reconnect.

Parameters

edge

SRoutableElementImpl

routingPoints

Point[]

updateHandles

boolean

addRoutingPoints

boolean

Returns

void

Inherited from

AbstractEdgeRouter.cleanupRoutingPoints


commitRoute()

protected commitRoute(edge, routedPoints): void

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:432

Parameters

edge

SRoutableElementImpl

routedPoints

RoutedPoint[]

Returns

void

Inherited from

AbstractEdgeRouter.commitRoute


createNewBezierSegment()

createNewBezierSegment(index, edge): void

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:247

Parameters

index

number

edge

SRoutableElementImpl

Returns

void


createRoutingHandles()

createRoutingHandles(edge): void

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:96

Creates the routing handles for the given target.

Parameters

edge

SRoutableElementImpl

Returns

void

Overrides

AbstractEdgeRouter.createRoutingHandles


derivativeAt()

derivativeAt(edge, t): undefined | Point

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:134

Calculates the derivative at a point on the edge.

Parameters

edge

SRoutableElementImpl

t

number

a value between 0 (sourceAnchor) and 1 (targetAnchor)

Returns

undefined | Point

the point or undefined if t is out of bounds or it cannot be computed

Inherited from

AbstractEdgeRouter.derivativeAt


findBezierControl()

protected findBezierControl(edge, route, handleIndex): Point

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:143

Parameters

edge

SRoutableElementImpl

route

RoutedPoint[]

handleIndex

number

Returns

Point


findOrthogonalIntersection()

findOrthogonalIntersection(edge, point): object

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:91

Finds the orthogonal intersection point between an edge and a given point in 2D space.

Parameters

edge

SRoutableElementImpl

The edge to find the intersection point on.

point

Point

The point to find the intersection with.

Returns

object

The intersection point and its derivative on the respective edge segment.

derivative

derivative: Point

point

point: Point

Inherited from

AbstractEdgeRouter.findOrthogonalIntersection


findRouteSegment()

protected findRouteSegment(edge, route, handleIndex): object

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:217

Parameters

edge

SRoutableElementImpl

route

RoutedPoint[]

handleIndex

number

Returns

object

end?

optional end: Point

start?

optional start: Point

Inherited from

AbstractEdgeRouter.findRouteSegment


getAnchorComputer()

protected getAnchorComputer(connectable): IAnchorComputer

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:245

Parameters

connectable

SConnectableElementImpl

Returns

IAnchorComputer

Inherited from

AbstractEdgeRouter.getAnchorComputer


getHandlePosition()

getHandlePosition(edge, route, handle): undefined | Point

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:192

Retuns the position of the given handle based on the routing points of the edge.

Parameters

edge

SRoutableElementImpl

route

RoutedPoint[]

handle

SRoutingHandleImpl

Returns

undefined | Point

Inherited from

AbstractEdgeRouter.getHandlePosition


getInnerHandlePosition()

getInnerHandlePosition(edge, route, handle): undefined | RoutedPoint | { x: number; y: number; }

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:126

Parameters

edge

SRoutableElementImpl

route

RoutedPoint[]

handle

SRoutingHandleImpl

Returns

undefined | RoutedPoint | { x: number; y: number; }

Overrides

AbstractEdgeRouter.getInnerHandlePosition


getOptions()

protected getOptions(edge): LinearRouteOptions

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:232

Parameters

edge

SRoutableElementImpl

Returns

LinearRouteOptions

Overrides

AbstractEdgeRouter.getOptions


getSelfEdgeIndex()

protected getSelfEdgeIndex(edge): number

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:424

Parameters

edge

SRoutableElementImpl

Returns

number

Inherited from

AbstractEdgeRouter.getSelfEdgeIndex


getTranslatedAnchor()

getTranslatedAnchor(connectable, refPoint, refContainer, edge, anchorCorrection): Point

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:237

Parameters

connectable

SConnectableElementImpl

refPoint

Point

refContainer

SParentElementImpl

edge

SRoutableElementImpl

anchorCorrection

number = 0

Returns

Point

Inherited from

AbstractEdgeRouter.getTranslatedAnchor


pointAt()

pointAt(edge, t): undefined | Point

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:126

Calculates a point on the edge

Parameters

edge

SRoutableElementImpl

t

number

a value between 0 (sourceAnchor) and 1 (targetAnchor)

Returns

undefined | Point

the point or undefined if t is out of bounds or it cannot be computed

Inherited from

AbstractEdgeRouter.pointAt


removeBezierSegment()

removeBezierSegment(index, edge): void

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:273

Parameters

index

number

edge

SRoutableElementImpl

Returns

void


resetRoutingPointsOnReconnect()

protected resetRoutingPointsOnReconnect(edge, routingPoints, updateHandles, sourceAnchors, targetAnchors): boolean

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:290

Parameters

edge

SRoutableElementImpl

routingPoints

Point[]

updateHandles

boolean

sourceAnchors

DefaultAnchors

targetAnchors

DefaultAnchors

Returns

boolean

Inherited from

AbstractEdgeRouter.resetRoutingPointsOnReconnect


route()

route(edge): RoutedPoint[]

Defined in: packages/sprotty/src/features/routing/bezier-edge-router.ts:40

Calculates the route of the given edge.

Parameters

edge

SRoutableElementImpl

Returns

RoutedPoint[]

Overrides

AbstractEdgeRouter.route


takeSnapshot()

takeSnapshot(edge): EdgeSnapshot

Defined in: packages/sprotty/src/features/routing/abstract-edge-router.ts:362

Creates a snapshot of the given edge, storing all the data needed to restore it to its current state.

Parameters

edge

SRoutableElementImpl

Returns

EdgeSnapshot

Inherited from

AbstractEdgeRouter.takeSnapshot