Class BezierPathInteractionHelper

Classdesc

A helper for adding vertices to and remove vertices from Bézier paths. By default the 'delete' key is used to remove vertices or paths.

For convenience this helper is capable of handling multiple paths which are kept in an array.

Demo

Constructors

constructor

new BezierPathInteractionHelper(pb, paths, options): BezierPathInteractionHelper
Pre: all paths must have been added to the PlotBoilerplate's drawable buffer (use the add(Drawable) function).

The move callback accepts four params:
- The point on the closest curve (Vertex)
- The mouse or touch position (Vertex)
- The curve position (float t)
- The curve index on the array (integer)
Parameters
- pb: PlotBoilerplate
- paths: BezierPath[]
- options: HelperOptions
Returns BezierPathInteractionHelper
Name
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:151

Properties

`Private` _keyHandler

_keyHandler: KeyHandler

`Private` _mouseEnterListener

_mouseEnterListener: (() => void)

Type declaration

- (): void
- Returns void

`Private` _mouseHandler

_mouseHandler: MouseHandler

`Private` _mouseLeaveListener

_mouseLeaveListener: (() => void)

Type declaration

- (): void
- Returns void

`Private` _touchHandler

_touchHandler: AlloyFinger

`Private` allowPathRemoval

allowPathRemoval: boolean

`Private` autoAdjustPaths

autoAdjustPaths: boolean

`Private` currentA

currentA: Vertex

`Private` currentB

currentB: Vertex

`Private` currentDistance

currentDistance: number

`Private` currentPathIndex

currentPathIndex: number

`Private` currentT

currentT: number

`Private` maxDetectDistance

maxDetectDistance: number

`Private` mouseIsOver

mouseIsOver: boolean

`Private` onPathRemoved

onPathRemoved: OnPathRemoved

`Private` onPointerMoved

onPointerMoved: OnPointerMoved

`Private` onVertexInserted

onVertexInserted: OnVertexInserted

`Private` onVerticesDeleted

onVerticesDeleted: OnVerticesDeleted

`Private` paths

paths: BezierPath[]

`Private` pb

pb: PlotBoilerplate

Member

Memberof

BezierPathInteractionHelper

Instance

Methods

`Private` _clearMoveEvent

_clearMoveEvent(): void
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:429

`Private` _handleDelete

_handleDelete(): void
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:304

`Private` _handleDeleteOnPath

_handleDeleteOnPath(pathIndex): boolean
Parameters
- pathIndex: number
Returns boolean
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:342

`Private` _handleMoveEvent

_handleMoveEvent(posX, posY): void
Parameters
- posX: number
- posY: number
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:411

`Private` _removeDefaultPathListeners

_removeDefaultPathListeners(path): void
Parameters
- path: BezierPath
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:532

`Private` _replacePathAt

_replacePathAt(pathIndex, newPath): void
Parameters
- pathIndex: number
- newPath: BezierPath
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:398

`Private` _updateMinDistance

_updateMinDistance(): void
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:539

addPath

addPath(path): boolean
Manually add a path to this helper. Note that if autoAdjustPaths==true then listeners will be installed to the path's vertices to keep the path smooth at all times.
Parameters
- path: BezierPath
  The path to add.
Returns boolean
Duplicate path instances cannot be added; function will return false if path already exists.

Method
addPath

Instance
Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:209

destroy

destroy(): void
This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used any more.

Returns void
Method
destroy

Instance
Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:276

removePath

removePath(path): boolean
Manually remove a path from this helper. Note that this method ignores the allowPathRemoval option.
Parameters
- path: BezierPath
  The path to remove.
Returns boolean
Returns false if the path could not be found.

Method
removePath

Instance
Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:227

removePathAt

removePathAt(pathIndex): void
Remove the path at the given index.
Parameters
- pathIndex: number
  The index of the path (must be inside bounds, see this.paths array).
Returns void
Method
removePathAt

Instance
Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:243

update

update(): void
Update the inner status by running the distance calculation again with the current settings.

Call this if any of the properties changed (like maxDetecDistance).

Returns void
Method
update

Instance
Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:261

`Static` addPathVertexDragEndListeners

addPathVertexDragEndListeners(path, vertexDragEndListener): void
A helper function to add drag-end listeners to all vertices of the given path.
Parameters
- path: BezierPath
  The Bézier path to add vertex listeners to.
- vertexDragEndListener: VertListener
  The drag listeners to add to each path vertex.
Returns void
void

Static
Method
addPathVertexDragEndListeners

Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:696

`Static` addPathVertexDragListeners

addPathVertexDragListeners(path, vertexDragListener): void
A helper function to add drag listeners to all vertices of the given path.
Parameters
- path: BezierPath
  The Bézier path to add vertex listeners to.
- vertexDragListener: VertListener
  The drag listeners to add to each path vertex.
Returns void
void

Static
Method
addPathVertexDragListeners

Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:653

`Static` addPathVertexDragStartListeners

addPathVertexDragStartListeners(path, vertexDragStartListener): void
A helper function to add drag-start listeners to all vertices of the given path.
Parameters
- path: BezierPath
  The Bézier path to add vertex listeners to.
- vertexDragStartListener: VertListener
  The drag listeners to add to each path vertex.
Returns void
void

Static
Method
addPathVertexDragStartListeners

Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:609

`Static` removePathVertexDragEndListeners

removePathVertexDragEndListeners(path, vertexDragEndListener): void
A helper function to remove drag-end listeners to all vertices of the given path.
Parameters
- path: BezierPath
  The Bézier path to remove vertex listeners from.
- vertexDragEndListener: VertListener
Returns void
void

Static
Method
removePathVertexDragEndListeners

Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:719

`Static` removePathVertexDragListeners

removePathVertexDragListeners(path, vertexDragListener): void
A helper function to remove drag listeners to all vertices of the given path.
Parameters
- path: BezierPath
  The Bézier path to remove vertex listeners from.
- vertexDragListener: VertListener
  The drag listeners to remove from each path vertex.
Returns void
void

Static
Method
removePathVertexDragListeners

Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:675

`Static` removePathVertexDragStartListeners

removePathVertexDragStartListeners(path, vertexDragStartListener): void
A helper function to remove drag-start listeners to all vertices of the given path.
Parameters
- path: BezierPath
  The Bézier path to remove vertex listeners from.
- vertexDragStartListener: VertListener
Returns void
void

Static
Method
removePathVertexDragStartListeners

Memberof
BezierPathInteractionHelper
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:632

`Static` setPathAutoAdjust

setPathAutoAdjust(path): void
Parameters
- path: BezierPath
Returns void
- Defined in plotboilerplate/src/ts/utils/helpers/BezierPathInteractionHelper.ts:568

Class BezierPathInteractionHelper

Classdesc

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BezierPathInteractionHelper

Name

Properties

Private _keyHandler

Private _mouseEnterListener

Type declaration

Returns void

Private _mouseHandler

Private _mouseLeaveListener

Type declaration

Returns void

Private _touchHandler

Private allowPathRemoval

Private autoAdjustPaths

Private currentA

Private currentB

Private currentDistance

Private currentPathIndex

Private currentT

Private maxDetectDistance

Private mouseIsOver

Private onPathRemoved

Private onPointerMoved

Private onVertexInserted

Private onVerticesDeleted

Private paths

Private pb

Member

Memberof

Instance

Methods

Private _clearMoveEvent

Returns void

Private _handleDelete

Returns void

Private _handleDeleteOnPath

Parameters

Returns boolean

Private _handleMoveEvent

Parameters

Returns void

Private _handleSingleVertexDelete

Returns number[]

Private _installKeyListener

Returns KeyHandler

Private _installMouseListener

Returns MouseHandler

Private _installTouchListener

Returns AlloyFinger

Private _locatePath

Parameters

Returns number

Private _removeDefaultPathListeners

Parameters

Returns void

Private _replacePathAt

Parameters

Returns void

Private _updateMinDistance

Returns void

addPath

Parameters

Returns boolean

Method

Instance

Memberof

destroy

Returns void

Method

Instance

Memberof

`Private` _keyHandler

`Private` _mouseEnterListener

`Private` _mouseHandler

`Private` _mouseLeaveListener

`Private` _touchHandler

`Private` allowPathRemoval

`Private` autoAdjustPaths

`Private` currentA

`Private` currentB

`Private` currentDistance

`Private` currentPathIndex

`Private` currentT

`Private` maxDetectDistance

`Private` mouseIsOver

`Private` onPathRemoved

`Private` onPointerMoved

`Private` onVertexInserted

`Private` onVerticesDeleted

`Private` paths

`Private` pb

`Private` _clearMoveEvent

`Private` _handleDelete

`Private` _handleDeleteOnPath

`Private` _handleMoveEvent

`Private` _handleSingleVertexDelete

`Private` _installKeyListener

`Private` _installMouseListener

`Private` _installTouchListener

`Private` _locatePath

`Private` _removeDefaultPathListeners

`Private` _replacePathAt

`Private` _updateMinDistance

`Static` addPathVertexDragEndListeners

`Static` addPathVertexDragListeners

`Static` addPathVertexDragStartListeners

`Static` removePathVertexDragEndListeners

`Static` removePathVertexDragListeners

`Static` removePathVertexDragStartListeners

`Static` setPathAutoAdjust