Maker.js, a Microsoft Garage project, is a JavaScript library for creating and sharing modular line drawings for CNC and laser cutters.

View project on GitHub

Star

Api - PointGraph Class

A graph of items which may be located on the same points.

Type parameters

T

Hierarchy

PointGraph

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PointGraph(): PointGraph

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:175
Returns PointGraph

Properties

graph

graph: object

Map of unique points by x, then y, to a point id. This will remain intact even after merging.

Type declaration

[x: number]: object
- [y: number]: number

index

index: object

Index of points by id.

Type declaration

[pointId: number]: IPointGraphIndexElement

insertedCount

insertedCount: number

Number of points inserted

merged

merged: object

Map of point ids which once existed but have been merged into another id due to close proximity.

Type declaration

[pointId: number]: number

values

values: T[]

List of values inserted at points.

Methods

forEachPoint

forEachPoint(cb: function): void

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:311
Iterate over points in the index.

Parameters
- cb: function
  
  Callback for each point in the index.
  - - (p: IPoint, values: T[], pointId?: number, el?: IPointGraphIndexElement): void
    - Parameters
      - p: IPoint
      - values: T[]
      - Optional pointId: number
      - Optional el: IPointGraphIndexElement
      Returns void
Returns void

getElementAtPoint

getElementAtPoint(p: IPoint): IPointGraphIndexElement

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:344
Get the index element of a point, after merging.

Parameters
- p: IPoint
  
  Point to look up index element.
Returns IPointGraphIndexElement

getIdOfPoint

getIdOfPoint(p: IPoint): number

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:326
Gets the id of a point, after merging.

Parameters
- p: IPoint
  
  Point to look up id.
Returns number

insertValue

insertValue(value: T): number

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:197
Insert a value.

Parameters
- value: T
  
  Value associated with this point.
Returns number

valueId of the inserted value.

insertValueIdAtPoint

insertValueIdAtPoint(valueId: number, p: IPoint): object

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:207
Insert a value at a point.

Parameters
- valueId: number
- p: IPoint
  
  Point.
Returns object
- existed: boolean
- pointId: number

mergeNearestSinglePoints

mergeNearestSinglePoints(withinDistance: number): void

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:266
Finds all points which have only one value associated. Then, merge to the nearest other point within this set. Call this after inserting values.

Parameters
- withinDistance: number
  
  Distance to consider points equal.
Returns void

mergePoints

mergePoints(withinDistance: number): void

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:239
Merge points within a given distance from each other. Call this after inserting values.

Parameters
- withinDistance: number
  
  Distance to consider points equal.
Returns void

reset

reset(): void

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:184
Reset the stored points, graphs, lists, to initial state.

Returns void

Generated using TypeDoc