SnapModule | @shapediver/viewer-repository

This version of the ShapeDiver viewer is no longer supported.

Please refer to the version 3 documentation here. See also the migration guide from version 2 to version 3 here.

Hierarchy

SnapModule

Implements

ISnapModule

Index

Constructors

constructor

Accessors

EVENTTYPE

Methods

Constructors

constructor

new SnapModule(api: ApiInterfaceV2): SnapModule

- Defined in SnapModule.ts:33
Creates the SnapModule.

Cannot be created without the api reference.

Parameters
- api: ApiInterfaceV2
Returns SnapModule

Accessors

EVENTTYPE

get EVENTTYPE(): { DRAG_END: string; DRAG_MOVE: string; DRAG_START: string }

- Defined in SnapModule.ts:146
Get all possible event types.

Returns { DRAG_END: string; DRAG_MOVE: string; DRAG_START: string }
- DRAG_END: string
  
  "drag.end"
- DRAG_MOVE: string
  
  "drag.move"
- DRAG_START: string
  
  "drag.start"

Methods

addAnchorElement

addAnchorElement(anchorDefinition: IAnchorElementDefinition): string

Implementation of ISnapModule.addAnchorElement
- Defined in SnapModule.ts:104
Add an anchor element that can snap to the snap elements.

Parameters
- anchorDefinition: IAnchorElementDefinition
Returns string

the ID of the created element

addEventListener

addEventListener(type: string, cb: (event: IEventData) => {}): string

- Defined in SnapModule.ts:125
Add an event listener for the specified type with the specified callback.

Parameters
- type: string
  
  EVENTTYPE
- cb: (event: IEventData) => {}
  - - (event: IEventData): {}
    - Parameters
      - event: IEventData
      Returns {}
Returns string

addSnapLine

addSnapLine(lineDefinition: ISnapLineDefinition): string

Implementation of ISnapModule.addSnapLine
- Defined in SnapModule.ts:83
Add a line which can be snapped to.

Parameters
- lineDefinition: ISnapLineDefinition
Returns string

the ID of the created element

addSnapPoint

addSnapPoint(pointDefinition: ISnapPointDefinition): string

Implementation of ISnapModule.addSnapPoint
- Defined in SnapModule.ts:63
Add a point which can be snapped to.

Parameters
- pointDefinition: ISnapPointDefinition
Returns string

the ID of the created element

removeAnchorElement

removeAnchorElement(id: string): void

Implementation of ISnapModule.removeAnchorElement
- Defined in SnapModule.ts:115
Remove an anchor element from the list of anchor elements.

Parameters
- id: string
Returns void

removeEventListener

removeEventListener(id: string): void

Implementation of ISnapModule.removeEventListener
- Defined in SnapModule.ts:137
Remove an event listener.

Parameters
- id: string
Returns void

removeSnapLine

removeSnapLine(id: string): void

Implementation of ISnapModule.removeSnapLine
- Defined in SnapModule.ts:94
Remove a line from the list of lines which can be snapped to.

Parameters
- id: string
Returns void

removeSnapPoint

removeSnapPoint(id: string): void

Implementation of ISnapModule.removeSnapPoint
- Defined in SnapModule.ts:73
Remove a point from the list of points which can be snapped to.

Parameters
- id: string
Returns void