Api - measure Namespace

Functions

augment

augment(measureToAugment: IMeasure): IMeasureWithCenter

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:550
Augment a measurement - add more properties such as center point, height and width.

Parameters
- measureToAugment: IMeasure
  
  The measurement to augment.
Returns IMeasureWithCenter

Measurement object with augmented properties.

boundingHexagon

boundingHexagon(modelToMeasure: IModel): IBoundingHex

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:747
Measures the minimum bounding hexagon surrounding a model. The hexagon is oriented such that the right and left sides are vertical, and the top and bottom are pointed.

Parameters
- modelToMeasure: IModel
  
  The model to measure.
Returns IBoundingHex

IBoundingHex object which is a hexagon model, with an additional radius property.

increase

increase(baseMeasure: IMeasure, addMeasure: IMeasure, augmentBaseMeasure?: boolean): IMeasure

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:20
Increase a measurement by an additional measurement.

Parameters
- baseMeasure: IMeasure
  
  The measurement to increase.
- addMeasure: IMeasure
  
  The additional measurement.
- Optional augmentBaseMeasure: boolean
  
  Optional flag to call measure.augment on the measurement.
Returns IMeasure

The increased original measurement (for cascading).

isAngleEqual

isAngleEqual(angleA: number, angleB: number, accuracy?: number): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:10
Find out if two angles are equal.

Parameters
- angleA: number
  
  First angle.
- angleB: number
  
  Second angle.
- Default value accuracy: number = 0.0001
Returns boolean

true if angles are the same, false if they are not

isArcConcaveTowardsPoint

isArcConcaveTowardsPoint(arc: IPathArc, towardsPoint: IPoint): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:57
Check for arc being concave or convex towards a given point.

Parameters
- arc: IPathArc
  
  The arc to test.
- towardsPoint: IPoint
  
  The point to test.
Returns boolean

Boolean true if arc is concave towards point.

isArcOverlapping

isArcOverlapping(arcA: IPathArc, arcB: IPathArc, excludeTangents: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:77
DEPRECATED - use isArcSpanOverlapping() instead.

Parameters
- arcA: IPathArc
- arcB: IPathArc
- excludeTangents: boolean
Returns boolean

isArcSpanOverlapping

isArcSpanOverlapping(arcA: IPathArc, arcB: IPathArc, excludeTangents: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:89
Check for arc overlapping another arc.

Parameters
- arcA: IPathArc
  
  The arc to test.
- arcB: IPathArc
  
  The arc to check for overlap.
- excludeTangents: boolean
  
  Boolean to exclude exact endpoints and only look for deep overlaps.
Returns boolean

Boolean true if arcA is overlapped with arcB.

isBetween

isBetween(valueInQuestion: number, limitA: number, limitB: number, exclusive: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:113
Check if a given number is between two given limits.

Parameters
- valueInQuestion: number
  
  The number to test.
- limitA: number
  
  First limit.
- limitB: number
  
  Second limit.
- exclusive: boolean
  
  Flag to exclude equaling the limits.
Returns boolean

Boolean true if value is between (or equal to) the limits.

isBetweenArcAngles

isBetweenArcAngles(angleInQuestion: number, arc: IPathArc, exclusive: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:129
Check if a given angle is between an arc's start and end angles.

Parameters
- angleInQuestion: number
  
  The angle to test.
- arc: IPathArc
  
  Arc to test against.
- exclusive: boolean
  
  Flag to exclude equaling the start or end angles.
Returns boolean

Boolean true if angle is between (or equal to) the arc's start and end angles.

isBetweenPoints

isBetweenPoints(pointInQuestion: IPoint, line: IPathLine, exclusive: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:149
Check if a given point is between a line's end points.

Parameters
- pointInQuestion: IPoint
  
  The point to test.
- line: IPathLine
  
  Line to test against.
- exclusive: boolean
  
  Flag to exclude equaling the origin or end points.
Returns boolean

Boolean true if point is between (or equal to) the line's origin and end points.

isBezierSeedLinear

isBezierSeedLinear(seed: IPathBezierSeed, exclusive?: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:171
Check if a given bezier seed has all points on the same slope.

Parameters
- seed: IPathBezierSeed
  
  The bezier seed to test.
- Optional exclusive: boolean
  
  Optional boolean to test only within the boundary of the endpoints.
Returns boolean

Boolean true if bezier seed has control points on the line slope and between the line endpoints.

isChainClockwise

isChainClockwise(chainContext: IChain, out_result?: object): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:205
Check for flow of paths in a chain being clockwise or not.

Parameters
- chainContext: IChain
  
  The chain to test.
- Optional out_result: object
  
  Optional output object, if provided, will be populated with convex hull results.
  - Optional hullPoints?: IPoint[]
  - Optional keyPoints?: IPoint[]
Returns boolean

Boolean true if paths in the chain flow clockwise.

isLineOverlapping

isLineOverlapping(lineA: IPathLine, lineB: IPathLine, excludeTangents: boolean): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:272
Check for line overlapping another line.

Parameters
- lineA: IPathLine
  
  The line to test.
- lineB: IPathLine
  
  The line to check for overlap.
- excludeTangents: boolean
  
  Boolean to exclude exact endpoints and only look for deep overlaps.
Returns boolean

Boolean true if lineA is overlapped with lineB.

isMeasurementOverlapping

isMeasurementOverlapping(measureA: IMeasure, measureB: IMeasure): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:294
Check for measurement overlapping another measurement.

Parameters
- measureA: IMeasure
  
  The measurement to test.
- measureB: IMeasure
  
  The measurement to check for overlap.
Returns boolean

Boolean true if measureA is overlapped with measureB.

isPathEqual

isPathEqual(pathA: IPath, pathB: IPath, withinPointDistance?: number, pathAOffset?: IPoint, pathBOffset?: IPoint): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:49
Find out if two paths are equal.

Parameters
- pathA: IPath
  
  First path.
- pathB: IPath
  
  Second path.
- Optional withinPointDistance: number
- Optional pathAOffset: IPoint
- Optional pathBOffset: IPoint
Returns boolean

true if paths are the same, false if they are not

isPointArrayClockwise

isPointArrayClockwise(points: IPoint[], out_result?: object): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:224
Check for array of points being clockwise or not.

Parameters
- points: IPoint[]
  
  The array of points to test.
- Optional out_result: object
  
  Optional output object, if provided, will be populated with convex hull results.
  - Optional hullPoints?: IPoint[]
  - Optional keyPoints?: IPoint[]
Returns boolean

Boolean true if points flow clockwise.

isPointDistinct

isPointDistinct(pointToCheck: IPoint, pointArray: IPoint[], withinDistance?: number): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:98
Find out if a point is distinct among an array of points.

Parameters
- pointToCheck: IPoint
  
  point to check.
- pointArray: IPoint[]
  
  array of points.
- Optional withinDistance: number
  
  Optional distance to consider points equal.
Returns boolean

false if point is equal to any point in the array.

isPointEqual

isPointEqual(a: IPoint, b: IPoint, withinDistance?: number): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:80
Find out if two points are equal.

Parameters
- a: IPoint
  
  First point.
- b: IPoint
  
  Second point.
- Optional withinDistance: number
  
  Optional distance to consider points equal.
Returns boolean

true if points are the same, false if they are not

isPointInsideModel

isPointInsideModel(pointToCheck: IPoint, modelContext: IModel, options?: IMeasurePointInsideOptions): boolean

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:866
Check to see if a point is inside of a model.

Parameters
- pointToCheck: IPoint
  
  The point to check.
- modelContext: IModel
  
  The model to check against.
- Default value options: IMeasurePointInsideOptions = {}
  
  Optional IMeasurePointInsideOptions object.
Returns boolean

Boolean true if the path is inside of the modelContext.

isPointOnCircle

isPointOnCircle(p: IPoint, circle: IPathCircle, withinDistance?: number): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:133
Find out if point is on a circle.

Parameters
- p: IPoint
  
  Point to check.
- circle: IPathCircle
  
  Circle.
- Default value withinDistance: number = 0
  
  Optional distance of tolerance.
Returns boolean

true if point is on the circle

isPointOnPath

isPointOnPath(pointToCheck: IPoint, onPath: IPath, withinDistance?: number, pathOffset?: IPoint, options?: IIsPointOnPathOptions): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:171
Find out if a point lies on a path.

Parameters
- pointToCheck: IPoint
  
  point to check.
- onPath: IPath
  
  path to check against.
- Default value withinDistance: number = 0
  
  Optional distance to consider point on the path.
- Optional pathOffset: IPoint
  
  Optional offset of path from [0, 0].
- Optional options: IIsPointOnPathOptions
  
  Optional IIsPointOnPathOptions to cache computation.
Returns boolean

isPointOnSlope

isPointOnSlope(p: IPoint, slope: ISlope, withinDistance?: number): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:115
Find out if point is on a slope.

Parameters
- p: IPoint
  
  Point to check.
- slope: ISlope
- Default value withinDistance: number = 0
  
  Optional distance of tolerance.
Returns boolean

true if point is on the slope

isSlopeEqual

isSlopeEqual(slopeA: ISlope, slopeB: ISlope): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:187
Check for slope equality.

Parameters
- slopeA: ISlope
  
  The ISlope to test.
- slopeB: ISlope
  
  The ISlope to check for equality.
Returns boolean

Boolean true if slopes are equal.

isSlopeParallel

isSlopeParallel(slopeA: ISlope, slopeB: ISlope): boolean

- Defined in src/maker.js/packages/maker.js/src/core/equal.ts:228
Check for parallel slopes.

Parameters
- slopeA: ISlope
  
  The ISlope to test.
- slopeB: ISlope
  
  The ISlope to check for parallel.
Returns boolean

Boolean true if slopes are parallel.

lineSlope

lineSlope(line: IPathLine): ISlope

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:305
Gets the slope of a line.

Parameters
- line: IPathLine
Returns ISlope

modelExtents

modelExtents(modelToMeasure: IModel, atlas?: Atlas): IMeasureWithCenter

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:494
Measures the smallest rectangle which contains a model.

Parameters
- modelToMeasure: IModel
  
  The model to measure.
- Optional atlas: Atlas
  
  Optional atlas to save measurements.
Returns IMeasureWithCenter

object with low and high points.

modelPathLength

modelPathLength(modelToMeasure: IModel): number

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:465
Measures the length of all paths in a model.

Parameters
- modelToMeasure: IModel
  
  The model containing paths to measure.
Returns number

Length of all paths in the model.

pathExtents

pathExtents(pathToMeasure: IPath, addOffset?: IPoint): IMeasure

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:398
Calculates the smallest rectangle which contains a path.

Parameters
- pathToMeasure: IPath
  
  The path to measure.
- Optional addOffset: IPoint
Returns IMeasure

object with low and high points.

pathLength

pathLength(pathToMeasure: IPath): number

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:447
Measures the length of a path.

Parameters
- pathToMeasure: IPath
  
  The path to measure.
Returns number

Length of the path.

pointDistance

pointDistance(a: IPoint, b: IPoint): number

- Defined in src/maker.js/packages/maker.js/src/core/measure.ts:334
Calculates the distance between two points.

Parameters
- a: IPoint
  
  First point.
- b: IPoint
  
  Second point.
Returns number

Distance between points.

Generated using TypeDoc

Api - measure Namespace

Index

Classes

Functions

Functions

augment

Parameters

measureToAugment: IMeasure

Returns IMeasureWithCenter

boundingHexagon

Parameters

modelToMeasure: IModel

Returns IBoundingHex

increase

Parameters

baseMeasure: IMeasure

addMeasure: IMeasure

Optional augmentBaseMeasure: boolean

Returns IMeasure

isAngleEqual

Parameters

angleA: number

angleB: number

Default value accuracy: number = 0.0001

Returns boolean

isArcConcaveTowardsPoint

Parameters

arc: IPathArc

towardsPoint: IPoint

Returns boolean

isArcOverlapping

Parameters

arcA: IPathArc

arcB: IPathArc

excludeTangents: boolean

Returns boolean

isArcSpanOverlapping

Parameters

arcA: IPathArc

arcB: IPathArc

excludeTangents: boolean

Returns boolean

isBetween

Parameters

valueInQuestion: number

limitA: number

limitB: number

exclusive: boolean

Returns boolean

isBetweenArcAngles

Parameters

angleInQuestion: number

arc: IPathArc

exclusive: boolean

Returns boolean

isBetweenPoints

Parameters

pointInQuestion: IPoint

line: IPathLine

exclusive: boolean

Returns boolean

isBezierSeedLinear

Parameters

seed: IPathBezierSeed

Optional exclusive: boolean

Returns boolean

isChainClockwise

Parameters

chainContext: IChain

Optional out_result: object

Optional hullPoints?: IPoint[]

Optional keyPoints?: IPoint[]

Returns boolean

isLineOverlapping

Parameters

lineA: IPathLine

lineB: IPathLine

excludeTangents: boolean

Returns boolean

isMeasurementOverlapping