Class Polyline

Represents an ordered set of points connected by linear segments.

Remarks

The polyline is using the Array class as its base class. So you can use all Array methods on a polyline. Polylines are closed if start and end points coincide.

Hierarchy

Point3dList
- Polyline

Constructors

constructor

new Polyline(points: Point3d[]): Polyline
Init a new polyline from a list of points.
Parameters
- points: Point3d[]
  
  The points that define the polyline.
Returns Polyline
Overrides Point3dList.constructor
- Defined in Polyline.ts:19

Properties

`Protected` items

items: Point3d[]

The internal array of items.

Accessors

BoundingBox

get BoundingBox(): BoundingBox
Even though this is a property, it is not a "fast" calculation. Every point is evaluated in order to get the bounding box of the list.

Returns BoundingBox
Inherited from Point3dList.BoundingBox
- Defined in List.ts:250

CenterPoint

get CenterPoint(): Point3d
Compute the center point of the polyline as the weighted average of all segments.

Returns Point3d
- Defined in Polyline.ts:27

Count

get Count(): number
Gets the number of elements actually contained in the List.

Returns number
Inherited from Point3dList.Count
- Defined in List.ts:39

First

get First(): T
Gets or sets the first item in the list. This is synonymous to calling List[0].

Returns T
Inherited from Point3dList.First
- Defined in List.ts:46
set First(value: T): void
Gets or sets the first item in the list. This is synonymous to calling List[0].
Parameters
- value: T
Returns void
Inherited from Point3dList.First
- Defined in List.ts:53

IsClosed

get IsClosed(): boolean
Gets a value that indicates whether this polyline is closed.

Remarks
The polyline is considered to be closed if its start is identical to its endpoint. Polylines less than 3 points long are not considered closed.

Returns boolean
- Defined in Polyline.ts:78

IsValid

get IsValid(): boolean
Gets a value that indicates whether this polyline is valid.

Remarks
Valid polylines have at least one segment, no Invalid points and no zero length segments. Closed polylines with only two segments are also not considered valid.

Returns boolean
- Defined in Polyline.ts:55

Last

get Last(): T
Gets or sets the last item in the list. This is synonymous to calling List[Count-1].

Returns T
Inherited from Point3dList.Last
- Defined in List.ts:60
set Last(value: T): void
Gets or sets the last item in the list. This is synonymous to calling List[Count-1].
Parameters
- value: T
Returns void
Inherited from Point3dList.Last
- Defined in List.ts:67

Length

get Length(): number
Gets the total length of the polyline.

Returns number
- Defined in Polyline.ts:85

NullOrUndefinedCount

get NullOrUndefinedCount(): number
Gets the number of null or undefined in this list.

Returns number
Inherited from Point3dList.NullOrUndefinedCount
- Defined in List.ts:158

SegmentCount

get SegmentCount(): number
Gets the number of segments for this polyline.

Returns number
- Defined in Polyline.ts:69

Methods

Add

Add(item: Point3d): void
Adds an object to the end of the List. Equivalent to the javascript Array.push method.
Parameters
- item: Point3d
  
  The object to be added to the end of the List.
Returns void
Inherited from Point3dList.Add
- Defined in List.ts:83

AddRange

AddRange(items: Point3d[]): void
Adds an array of items to the end of the List.
Parameters
- items: Point3d[]
  
  The array of items to be added to the end of the List.
Returns void
Inherited from Point3dList.AddRange
- Defined in List.ts:91

Clear

Clear(): void
Removes all elements from the List.

Returns void
Inherited from Point3dList.Clear
- Defined in List.ts:74

ClosestParameter

ClosestParameter(testPoint: Point3d): number
Gets the parameter along the polyline which is closest to a test-point.

Returns
The parameter along the polyline closest to testPoint.
Parameters
- testPoint: Point3d
  
  Point to approximate.
Returns number
- Defined in Polyline.ts:258

ClosestPoint

ClosestPoint(testPoint: Point3d): Point3d
Gets the point on the polyline which is closest to a test-point.

Returns
The point on the polyline closest to testPoint.
Parameters
- testPoint: Point3d
  
  Point to approximate.
Returns Point3d
- Defined in Polyline.ts:248

Contains

Contains(item: Point3d, fromIndex?: number): boolean
Equivalent to the javascript Array.includes method.
Parameters
- item: Point3d
- Optional fromIndex: number
Returns boolean
Inherited from Point3dList.Contains
- Defined in List.ts:98

DeleteShortSegments

DeleteShortSegments(tolerance?: number): Polyline
Retuens a new polyline which removed all points that are closer than tolerance to the previous point.

Remarks
Start and end points are left intact.

Returns
The new polyline
Parameters
- tolerance: number = Open3d.EPSILON
  
  Vertices closer together than tolerance will be removed.
Returns Polyline
- Defined in Polyline.ts:312

Exists

Exists(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): boolean
Equivalent to the javascript Array.some method.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns boolean
Inherited from Point3dList.Exists
- Defined in List.ts:105

Filter

Filter(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): Point3d[]
Equivalent to the javascript Array.filter method.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns Point3d[]
Inherited from Point3dList.Filter
- Defined in List.ts:186

Find

Find(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): undefined | Point3d
Equivalent to the javascript Array.find method.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns undefined | Point3d
Inherited from Point3dList.Find
- Defined in List.ts:112

FindAll

FindAll(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): Point3d[]
Equivalent to the javascript Array.filter method.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns Point3d[]
Inherited from Point3dList.FindAll
- Defined in List.ts:126

FindIndex

FindIndex(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): number
Equivalent to the javascript Array.findIndex method.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns number
Inherited from Point3dList.FindIndex
- Defined in List.ts:119

ForEach

ForEach(callbackfn: ((value: Point3d, index: number, array: Point3d[]) => void)): void
Equivalent to the javascript Array.forEach method.
Parameters
- callbackfn: ((value: Point3d, index: number, array: Point3d[]) => void)
  - - (value: Point3d, index: number, array: Point3d[]): void
    - Parameters
      
      value: Point3d
      
      index: number
      
      array: Point3d[]
      
      Returns void
Returns void
Inherited from Point3dList.ForEach
- Defined in List.ts:133

Get

Get(index: number): Point3d
Gets the element at the specified index.
Parameters
- index: number
Returns Point3d
Inherited from Point3dList.Get
- Defined in List.ts:25

GetSegments

GetSegments(): Line[]
Constructs an array of line segments that make up the entire polyline.

Returns
An array of line segments or empty if the polyline contains fewer than 2 points.

Returns Line[]
- Defined in Polyline.ts:295

Insert

Insert(index: number, item: Point3d): void
Adds a item to a specific index in the list.
Parameters
- index: number
  
  The zero-based index at which item should be inserted.
- item: Point3d
  
  The item to insert.
Returns void
Inherited from Point3dList.Insert
- Defined in List.ts:142

InsertRange

InsertRange(index: number, items: Point3d[]): void
Adds an array of items to a specific index in the list.
Parameters
- index: number
  
  The zero-based index at which items should be inserted.
- items: Point3d[]
  
  The items to insert.
Returns void
Inherited from Point3dList.InsertRange
- Defined in List.ts:151

IsClosedWithinTolerance

IsClosedWithinTolerance(tolerance: number): boolean
Determines whether the polyline is closed, provided a tolerance value.

Returns
true if the polyline is closed to within tolerance, false otherwise.
Parameters
- tolerance: number
  
  If the distance between the start and end point of the polyline is less than tolerance, the polyline is considered to be closed.
Returns boolean
- Defined in Polyline.ts:101

IsPlanar

IsPlanar(tolerance?: number): boolean
Check if the polyline is planar within the given tolerance.

Remarks
The polyline must have at least 3 points. Or it is considered nonplanar.

Returns
true if the polyline is planar.
Parameters
- tolerance: number = Open3d.EPSILON
Returns boolean
- Defined in Polyline.ts:407

IsPointInside

IsPointInside(point: Point3d, tolerance?: number): boolean
It checks if a point is inside a Closed Planar polyline.

Remarks
The polyline must be closed and planar. If not, it throws an exception. if the point is on the polyline, it returns false. If the point is not on the polyline plane, it returns false. It performs the even-odd-rule Algorithm (a raycasting algorithm) see https://en.wikipedia.org/wiki/Point_in_polygon

Returns
true if the point is inside the polyline.
Parameters
- point: Point3d
  
  the point to check.
- tolerance: number = Open3d.EPSILON
Returns boolean
- Defined in Polyline.ts:480

`Private` IsPointInside2D

IsPointInside2D(point: Point3d): boolean
It assumes the polyline is planar on the XY plane and checks if a point is inside the polyline.
Parameters
- point: Point3d
Returns boolean
- Defined in Polyline.ts:510

IsPointOn

IsPointOn(point: Point3d, tolerance?: number): boolean
Checks if a point is on the polyline.

Returns
true if the point is on the polyline.
Parameters
- point: Point3d
  
  the point to check.
- tolerance: number = Open3d.EPSILON
Returns boolean
- Defined in Polyline.ts:455

Map

Map<S>(callbackfn: ((value: Point3d, index: number, array: Point3d[]) => S)): S[]
A wrapper around the javascript Array.map method.
Type Parameters
- S
Parameters
- callbackfn: ((value: Point3d, index: number, array: Point3d[]) => S)
  - - (value: Point3d, index: number, array: Point3d[]): S
    - Parameters
      
      value: Point3d
      
      index: number
      
      array: Point3d[]
      
      Returns S
Returns S[]
Inherited from Point3dList.Map
- Defined in List.ts:193

PointAt

PointAt(t: number): Point3d
Gets the point on the polyline at the given parameter.

Returns
Polyline parameter.
Parameters
- t: number
  
  The integer part of the parameter indicates the index of the segment. like 1.4
Returns Point3d
- Defined in Polyline.ts:113

Pop

Pop(): undefined | Point3d
Equivalent to the javascript Array.pop method.

Returns undefined | Point3d
Inherited from Point3dList.Pop
- Defined in List.ts:172

Reduce

Reduce(callbackfn: ((previousValue: Point3d, currentValue: Point3d, currentIndex: number, array: Point3d[]) => Point3d)): Point3d
Equivalent to the javascript Array.reduce method.
Parameters
- callbackfn: ((previousValue: Point3d, currentValue: Point3d, currentIndex: number, array: Point3d[]) => Point3d)
  - - (previousValue: Point3d, currentValue: Point3d, currentIndex: number, array: Point3d[]): Point3d
    - Parameters
      
      previousValue: Point3d
      
      currentValue: Point3d
      
      currentIndex: number
      
      array: Point3d[]
      
      Returns Point3d
Returns Point3d
Inherited from Point3dList.Reduce
- Defined in List.ts:165

Remove

Remove(item: Point3d): void
Removes the first occurrence of a specific object from the List.
Parameters
- item: Point3d
Returns void
Inherited from Point3dList.Remove
- Defined in List.ts:200

RemoveAll

RemoveAll(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): void
Removes all items that match the given predicate.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns void
Inherited from Point3dList.RemoveAll
- Defined in List.ts:220

RemoveBy

RemoveBy(predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)): void
Removes the first item that matches the given predicate.
Parameters
- predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)
  - - (value: Point3d, index: number, obj: Point3d[]): boolean
    - Parameters
      
      value: Point3d
      
      index: number
      
      obj: Point3d[]
      
      Returns boolean
Returns void
Inherited from Point3dList.RemoveBy
- Defined in List.ts:211

Reverse

Reverse(): Point3d[]
Reverse the order of the items in the list.

Remarks
This method mutates the list and returns a reference.

Returns
The reversed list.

Returns Point3d[]
Inherited from Point3dList.Reverse
- Defined in List.ts:237

SegmentAt

SegmentAt(index: number): null | Line
Gets the line segment at the given index.

Returns
Line segment at index or null on failure.
Parameters
- index: number
  
  Index of segment to retrieve, if it is not integer, it will be floored.
Returns null | Line
- Defined in Polyline.ts:148

Set

Set(index: number, value: Point3d): void
Sets the element at the specified index.
Parameters
- index: number
- value: Point3d
Returns void
Inherited from Point3dList.Set
- Defined in List.ts:32

Shift

Shift(): undefined | Point3d
Equivalent to the javascript Array.shift method.

Returns undefined | Point3d
Inherited from Point3dList.Shift
- Defined in List.ts:179

Smooth

Smooth(amount: number): null | Polyline
Smoothens the polyline segments by averaging adjacent vertices. Smoothing requires a polyline with exclusively valid vertices.
Parameters
- amount: number
  
  Amount to smooth. Zero equals no smoothing, one equals complete smoothing.
Returns null | Polyline
- Defined in Polyline.ts:372

Sort

Sort(compareFn?: ((a: Point3d, b: Point3d) => number)): void
Equivalent to the javascript Array.sort method.
Parameters
- Optional compareFn: ((a: Point3d, b: Point3d) => number)
  - - (a: Point3d, b: Point3d): number
    - Parameters
      
      a: Point3d
      
      b: Point3d
      
      Returns number
Returns void
Inherited from Point3dList.Sort
- Defined in List.ts:228

TangentAt

TangentAt(t: number): Vector3d
Gets the unit tangent vector along the polyline at the given parameter. The integer part of the parameter indicates the index of the segment.

Returns
The tangent along the polyline at t.
Parameters
- t: number
  
  Polyline parameter.
Returns Vector3d
- Defined in Polyline.ts:165

Transform

Transform(transformation: Transform): Polyline
Transform the polyline using a Transformation matrix.

Returns
A new transformed polyline.
Parameters
- transformation: Transform
  
  Transformation matrix to apply.
Returns Polyline
- Defined in Polyline.ts:537

Trim

Trim(t0: number, t1: number): Polyline
Constructs a polyline out of a parameter subdomain in this curve.

Remarks
The integer part of the domain parameters indicate the index of the segment.

Returns
The polyline as defined by the subdomain.
Parameters
- t0: number
  
  The subdomain start of the polyline.
- t1: number
  
  The subdomain end of the polyline.
Returns Polyline
- Defined in Polyline.ts:188

TryGetArea

TryGetArea(tolerance?: number): null | number
Try get the area of the polyline if it is planar and closed.

Returns
the area or null if the polyline is not planar.
Parameters
- tolerance: number = Open3d.EPSILON
Returns null | number
- Defined in Polyline.ts:439

TryGetPlane

TryGetPlane(tolerance?: number): null | Plane
Try get the plane of the polyline if it is planar.

Returns
the plane or null if the polyline is not planar.
Parameters
- tolerance: number = Open3d.EPSILON
Returns null | Plane
- Defined in Polyline.ts:427

`Static` CreateFromPoints

CreateFromPoints(points: Point3d[]): Polyline
Initializes a new polyline from a collection of points.

Returns
A new polyline.
Parameters
- points: Point3d[]
Returns Polyline
- Defined in Polyline.ts:550

`Static` `Private` SignedPolygonArea

SignedPolygonArea(polyline: Polyline): number
This assumes the polyline is planar on the XY plane.
Parameters
- polyline: Polyline
Returns number
- Defined in Polyline.ts:570

`Static` `Private` Smooth

Smooth(v0: Point3d, v1: Point3d, v2: Point3d, amount: number): Point3d
Parameters
- v0: Point3d
- v1: Point3d
- v2: Point3d
- amount: number
Returns Point3d
- Defined in Polyline.ts:554

Class Polyline

Remarks

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

points: Point3d[]

Returns Polyline

Properties

Protected items

Accessors

BoundingBox

Returns BoundingBox

CenterPoint

Returns Point3d

Count

Returns number

First

Returns T

Parameters

value: T

Returns void

IsClosed

Remarks

Returns boolean

IsValid

Remarks

Returns boolean

Last

Returns T

Parameters

value: T

Returns void

Length

Returns number

NullOrUndefinedCount

Returns number

SegmentCount

Returns number

Methods

Add

Parameters

item: Point3d

Returns void

AddRange

Parameters

items: Point3d[]

Returns void

Clear

Returns void

ClosestParameter

Returns

Parameters

testPoint: Point3d

Returns number

ClosestPoint

Returns

Parameters

testPoint: Point3d

Returns Point3d

Contains

Parameters

item: Point3d

Optional fromIndex: number

Returns boolean

DeleteShortSegments

Remarks

Returns

Parameters

tolerance: number = Open3d.EPSILON

Returns Polyline

Exists

Parameters

predicate: ((value: Point3d, index: number, obj: Point3d[]) => boolean)

Parameters

`Protected` items

`Optional` fromIndex: number