Polyline

Polyline class

Represents an ordered set of points connected by linear segments. Polylines are closed if start and end points coincide.

Inheritence: RhinoList<Point3d>Rhino.Collections.Point3dListPolyline
Derived Classes:

Namespace: Rhino.Geometry
Polyline: references

Constructors (12)

Point3dList()

Initializes a new empty list with default capacity.

Point3dList(IEnumerable<Point3d> collection)

Initializes a new point list by copying the values from another set.

Point3dList(int initialCapacity)

Initializes a new point list with a preallocated initial capacity.

Point3dList(Point3d[] initialPoints)

Constructs a new point list from values in a point array.

Polyline()

Initializes a new empty polyline.

Polyline(IEnumerable<Point3d> collection)

Initializes a new polyline from a collection of points.

Polyline(int initialCapacity)

Initializes a new empty polyline with an initial capacity.

RhinoList<T>()

Initializes a new, empty list.

RhinoList<T>(IEnumerable<T> collection)

Initializes this list as a shallow duplicate of another list, array or any other enumerable set of T.

RhinoList<T>(int amount, T defaultValue)

Initializes a new list with a specified amount of values.

RhinoList<T>(int initialCapacity)

Initializes an empty list with a certain capacity.

RhinoList<T>(RhinoList<T> list)

Initializes an new list by shallow duplicating another list.

Properties (14)

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.

Capacity

Gets or sets the total number of elements the internal data structure can hold without resizing.

Count

Gets the number of elements actually contained in the List.

First

Gets or sets the first item in the list. This is synonymous to calling List[0].

IsClosed

Test a polyline to see if it is closed.

IsValid

Gets a value that indicates whether this polyline is valid.
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.

Item

Gets or sets the element at the specified index.

Last

Gets or sets the last item in the list. This is synonymous to calling List[Count-1].

Length

Gets the total length of the polyline.

NullCount

Gets the number of None references (Nothing in Visual Basic) in this list. If T is a ValueType, this property always return zero.

SegmentCount

Gets the number of segments for this polyline.

Returns an indexer with all X coordinates in this list.

Returns an indexer with all Y coordinates in this list.

Returns an indexer with all Z coordinates in this list.

Methods (88)

Add(Double x,Double y,Double z)

Adds a Point3d to the end of the list with given x,y,z coordinates.

Add(T item)

Adds an object to the end of the List.

AddRange(IEnumerable<T> collection)

Adds the elements of the specified collection to the end of the List.

AddRange(IEnumerable collection)

Adds the elements of the specified collection to the end of the List.

AsReadOnly()

Constructs a read-only wrapper of this class.

BinarySearch(Int32 index,Int32 count, T item, IComparer<T> comparer)

Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.

BinarySearch(T item, IComparer<T> comparer)

Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.

BinarySearch(T item)

Searches the entire sorted List for an element using the default comparer and returns the zero-based index of the element.

BreakAtAngles(Double angle)

Breaks this polyline into sections at sharp kinks. Closed polylines will also be broken at the first and last vertex.

CenterPoint()

Compute the center point of the polyline as the weighted average of all segments.

Clear()

Removes all elements from the List.

ClosestIndex(Point3d testPoint)

Finds the index of the point that is closest to a test point in this list.

ClosestIndexInList(IList<Point3d> list, Point3d testPoint)

Finds the index of the point in a list of points that is closest to a test point.

ClosestParameter(Point3d testPoint)

Gets the parameter along the polyline which is closest to a test-point.

ClosestPoint(Point3d testPoint)

Gets the point on the polyline which is closest to a test-point.

ClosestPointInList(IList<Point3d> list, Point3d testPoint)

Finds the point in a list of points that is closest to a test point.

CollapseShortSegments(Double tolerance)

Collapses all segments until none are shorter than tolerance. This function is significantly slower than DeleteShortSegments, since it recursively operates on the shortest segment. When a segment is collapsed the end-points are placed in the center of the segment.

Contains(T item)

Determines whether an element is in the List.

ConvertAll(Converter<T, TOutput> converter)

Aggregates all results of a conversion function over this table into a new list.

CopyTo(Int32 index, T[] array,Int32 arrayIndex,Int32 count)

Copies a range of elements from the List to a compatible one-dimensional array, starting at the specified index of the target array.

CopyTo(T[] array,Int32 arrayIndex)

Copies the entire List to a compatible one-dimensional array, starting at the specified index of the target array.

CopyTo(T[] array)

Copies the entire List to a compatible one-dimensional array, starting at the beginning of the target array.

CreateByJoiningLines(IEnumerable<Line> lines,Double tolerance,Boolean splitAtIntersections)

Creates polylines by joining lines.

CreateCircumscribedPolygon(Circle circle,Int32 sideCount)

Create a regular polygon circumscribe about a circle. The midpoints of the polygon's edges will be tangent to the circle.

CreateInscribedPolygon(Circle circle,Int32 sideCount)

Create a regular polygon inscribed in a circle. The vertices of the polygon will be on the circle.

CreateStarPolygon(Circle circle,Double radius,Int32 cornerCount)

Create a regular star polygon. The star begins at circle.PointAt(0) and the vertices alternate between being on circle and begin on a concentric circle of other_radius.

DeleteShortSegments(Double tolerance)

Removes all points that are closer than tolerance to the previous point.
Start and end points are left intact.

Duplicate()

Returns a deep copy of this polyline instance.

Duplicate()

Returns a shallow copy of this instance. If the generic type is comprised of only value types (struct, enum, ptr), then the result will be a deep copy.

Duplicate()

Returns a deep copy of this point list instance.

Equals(Point3dList other)

Determines if the point lists are exactly equal.

Equals(Object obj)

Overrides the default object equality to compare lists by value.

Exists(Predicate<T> match)

Determines whether the List contains elements that match the conditions defined by the specified predicate.

Find(Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List.

FindAll(Predicate<T> match)

Retrieves all the elements that match the conditions defined by the specified predicate.

FindIndex(Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.

FindIndex(Int32 startIndex, Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.

FindIndex(Int32 startIndex,Int32 count, Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.

FindLast(Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List.

FindLastIndex(Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.

FindLastIndex(Int32 startIndex, Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.

FindLastIndex(Int32 startIndex,Int32 count, Predicate<T> match)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.

ForEach(Action<T> action)

Performs the specified action on each element of the List.

GetEnumerator()

Constructs an enumerator that is capable of iterating over all items in this list.

GetHashCode()

Creates a hash code for this object.

GetRange(Int32 index,Int32 count)

Constructs a shallow copy of a range of elements in the source List.

GetSegments()

Constructs an array of line segments that make up the entire polyline.

IndexOf(T item,Int32 index,Int32 count)

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that starts at the specified index and contains the specified number of elements.

IndexOf(T item,Int32 index)

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.

IndexOf(T item)

Searches for the specified object and returns the zero-based index of the first occurrence within the entire List.

Insert(Int32 index, T item)

Inserts an element into the List at the specified index.

InsertRange(Int32 index, IEnumerable<T> collection)

Inserts the elements of a collection into the List at the specified index.

IsClosedWithinTolerance(Double tolerance)

Test a polyline to see if it is closed.

LastIndexOf(T item,Int32 index,Int32 count)

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index.

LastIndexOf(T item,Int32 index)

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index.

LastIndexOf(T item)

Searches for the specified object and returns the zero-based index of the last occurrence within the entire List.

MergeColinearSegments(Double angleTolerance,Boolean includeSeam)

Merge co-linear consecutive segments in a polyline. This method will automatically remove any zero-length segments as well.

PointAt(Double t)

Gets the point on the polyline at the given parameter. The integer part of the parameter indicates the index of the segment.

ReduceSegments(Double tolerance)

Constructs a reduction of this polyline by recursively removing the least significant segments.

RemapIndex(Int32 index)

Remap an index in the infinite range onto the List index range.

Remove(T item)

Removes the first occurrence of a specific object from the List.

RemoveAll(Predicate<T> match)

Removes the all the elements that match the conditions defined by the specified predicate.

RemoveAt(Int32 index)

Removes the element at the specified index of the List.

RemoveNearlyEqualSubsequentPoints(Double tolerance)

Removes one copy of a point that is equal to the previous or later point, by an absolute tolerance factor.

RemoveNulls()

Removes all elements from the List that are None references (Nothing in Visual Basic). This function will not do anything if T is not a Reference type.

RemoveRange(Int32 index,Int32 count)

Removes a range of elements from the List.

Reverse()

Reverses the order of the elements in the entire List.

Reverse(Int32 index,Int32 count)

Reverses the order of the elements in the specified range.

SegmentAt(Int32 index)

Gets the line segment at the given index.

SetAllX(Double xValue)

Set all the X values for the points to a single value

SetAllY(Double yValue)

Set all the Y values for the points to a single value

SetAllZ(Double zValue)

Set all the Z values for the points to a single value

Smooth(Double amount)

Smoothen the polyline segments by averaging adjacent vertices. Smoothing requires a polyline with exclusively valid vertices.

Sort()

Sorts the elements in the entire List using the default comparer.

Sort(Comparison<T> comparison)

Sorts the elements in the entire list using the specified comparer.

Sort(IComparer<T> comparer)

Sorts the elements in the entire list using the specified System.Comparison(T)

Sort(Double[] keys)

Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.

Sort(Int32 index,Int32 count, IComparer<T> comparer)

Sorts the elements in a range of elements in list using the specified comparer.

Sort(Int32[] keys)

Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.

TangentAt(Double t)

Gets the unit tangent vector along the polyline at the given parameter. The integer part of the parameter indicates the index of the segment.

ToArray()

Constructs an array that contains all items in this list.

ToNurbsCurve()

Constructs a nurbs curve representation of this polyline.

ToPolylineCurve()

Constructs a polyline curve representation of this polyline.

Transform(Transform xform)

Applies a transform to all the points in the list.

TriangulateClosedPolyline()

Attempts to create a list of triangles which represent a triangulation of a closed polyline

Trim(Interval domain)

Constructs a polyline out of a parameter sub-domain in this curve.

TrimExcess()

Sets the capacity to the actual number of elements in the List, if that number is less than a threshold value.

TrueForAll(Predicate<T> match)

Determines whether every element in the List matches the conditions defined by the specified predicate.

Nothing found