T_Rhino_Geometry_Polyline - mcneel/rhinocommon-api-docs GitHub Wiki

Polyline Class

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

Inheritance Hierarchy

System.Object
  Rhino.Collections.RhinoList(Point3d)
    Rhino.Collections.Point3dList
      Rhino.Geometry.Polyline
Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

[SerializableAttribute]
public class Polyline : Point3dList

VB

<SerializableAttribute>
Public Class Polyline
	Inherits Point3dList

The Polyline type exposes the following members.

Constructors

 

Name Description
Public method Polyline() Initializes a new empty polyline.
Public method Polyline(Int32) Initializes a new empty polyline with an initial capacity.
Public method Polyline(IEnumerable(Point3d)) Initializes a new polyline from a collection of points.
  Back to Top

Properties

 

Name Description
Public property 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. (Inherited from Point3dList.)
Public property Capacity Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from RhinoList(T).)
Public property Count Gets the number of elements actually contained in the List. (Inherited from RhinoList(T).)
Public property First Gets or sets the first item in the list. This is synonymous to calling List[0]. (Inherited from RhinoList(T).)
Public property IsClosed Gets a value that indicates whether this polyline is closed. The polyline is considered to be closed if its start is identical to its endpoint.
Public property 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.
Public property Item Gets or sets the element at the specified index. (Inherited from RhinoList(T).)
Public property Last Gets or sets the last item in the list. This is synonymous to calling List[Count-1]. (Inherited from RhinoList(T).)
Public property Length Gets the total length of the polyline.
Public property NullCount Gets the number of null references (Nothing in Visual Basic) in this list. If T is a ValueType, this property always return zero. (Inherited from RhinoList(T).)
Public property SegmentCount Gets the number of segments for this polyline.
Public property X Returns an indexer with all X coordinates in this list. (Inherited from Point3dList.)
Public property Y Returns an indexer with all Y coordinates in this list. (Inherited from Point3dList.)
Public property Z Returns an indexer with all Z coordinates in this list. (Inherited from Point3dList.)
  Back to Top

Methods

 

Name Description
Public method Add(T) Adds an object to the end of the List. (Inherited from RhinoList(T).)
Public methodCode example Add(Double, Double, Double) Adds a Point3d to the end of the list with given x,y,z coordinates. (Inherited from Point3dList.)
Public method AddRange(IEnumerable(T)) Adds the elements of the specified collection to the end of the List. (Inherited from RhinoList(T).)
Public method AddRange(IEnumerable) Adds the elements of the specified collection to the end of the List. (Inherited from RhinoList(T).)
Public method AsReadOnly Constructs a read-only wrapper of this class. (Inherited from RhinoList(T).)
Public method BinarySearch(T) Searches the entire sorted List for an element using the default comparer and returns the zero-based index of the element. (Inherited from RhinoList(T).)
Public method BinarySearch(T, IComparer(T)) Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element. (Inherited from RhinoList(T).)
Public method BinarySearch(Int32, Int32, T, IComparer(T)) Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element. (Inherited from RhinoList(T).)
Public method BreakAtAngles Breaks this polyline into sections at sharp kinks. Closed polylines will also be broken at the first and last vertex.
Public method CenterPoint Compute the center point of the polyline as the weighted average of all segments.
Public method Clear Removes all elements from the List. (Inherited from RhinoList(T).)
Public method ClosestIndex Finds the index of the point that is closest to a test point in this list. (Inherited from Point3dList.)
Public method ClosestParameter Gets the parameter along the polyline which is closest to a test-point.
Public method ClosestPoint Gets the point on the polyline which is closest to a test-point.
Public method CollapseShortSegments 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.
Public method Contains Determines whether an element is in the List. (Inherited from RhinoList(T).)
Public method ConvertAll(TOutput) Aggregates all results of a conversion function over this table into a new list. (Inherited from RhinoList(T).)
Public method CopyTo(T[]) Copies the entire List to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from RhinoList(T).)
Public method CopyTo(T[], Int32) Copies the entire List to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from RhinoList(T).)
Public method CopyTo(Int32, T[], Int32, Int32) Copies a range of elements from the List to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from RhinoList(T).)
Public method DeleteShortSegments Removes all points that are closer than tolerance to the previous point. Start and end points are left intact.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Exists Determines whether the List contains elements that match the conditions defined by the specified predicate. (Inherited from RhinoList(T).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Find Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List. (Inherited from RhinoList(T).)
Public method FindAll Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from RhinoList(T).)
Public method FindIndex(Predicate(T)) 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. (Inherited from RhinoList(T).)
Public method FindIndex(Int32, Predicate(T)) 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. (Inherited from RhinoList(T).)
Public method FindIndex(Int32, Int32, Predicate(T)) 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. (Inherited from RhinoList(T).)
Public method FindLast Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List. (Inherited from RhinoList(T).)
Public method FindLastIndex(Predicate(T)) 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. (Inherited from RhinoList(T).)
Public method FindLastIndex(Int32, Predicate(T)) 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. (Inherited from RhinoList(T).)
Public method FindLastIndex(Int32, Int32, Predicate(T)) 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. (Inherited from RhinoList(T).)
Public method ForEach Performs the specified action on each element of the List. (Inherited from RhinoList(T).)
Public method GetEnumerator Constructs an enumerator that is capable of iterating over all items in this list. (Inherited from RhinoList(T).)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetRange Constructs a shallow copy of a range of elements in the source List. (Inherited from RhinoList(T).)
Public method GetSegments Constructs an array of line segments that make up the entire polyline.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf(T) Searches for the specified object and returns the zero-based index of the first occurrence within the entire List. (Inherited from RhinoList(T).)
Public method IndexOf(T, Int32) 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. (Inherited from RhinoList(T).)
Public method IndexOf(T, Int32, Int32) 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. (Inherited from RhinoList(T).)
Public method Insert Inserts an element into the List at the specified index. (Inherited from RhinoList(T).)
Public method InsertRange Inserts the elements of a collection into the List at the specified index. (Inherited from RhinoList(T).)
Public method IsClosedWithinTolerance Determines whether the polyline is closed, provided a tolerance value.
Public method LastIndexOf(T) Searches for the specified object and returns the zero-based index of the last occurrence within the entire List. (Inherited from RhinoList(T).)
Public method LastIndexOf(T, Int32) 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. (Inherited from RhinoList(T).)
Public method LastIndexOf(T, Int32, Int32) 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. (Inherited from RhinoList(T).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method PointAt Gets the point on the polyline at the given parameter. The integer part of the parameter indicates the index of the segment.
Public method ReduceSegments Constructs a reduction of this polyline by recursively removing the least significant segments.
Public method RemapIndex Remap an index in the infinite range onto the List index range. (Inherited from RhinoList(T).)
Public method Remove Removes the first occurrence of a specific object from the List. (Inherited from RhinoList(T).)
Public method RemoveAll Removes the all the elements that match the conditions defined by the specified predicate. (Inherited from RhinoList(T).)
Public method RemoveAt Removes the element at the specified index of the List. (Inherited from RhinoList(T).)
Public method RemoveNulls Removes all elements from the List that are null references (Nothing in Visual Basic). This function will not do anything if T is not a Reference type. (Inherited from RhinoList(T).)
Public method RemoveRange Removes a range of elements from the List. (Inherited from RhinoList(T).)
Public method Reverse() Reverses the order of the elements in the entire List. (Inherited from RhinoList(T).)
Public method Reverse(Int32, Int32) Reverses the order of the elements in the specified range. (Inherited from RhinoList(T).)
Public method SegmentAt Gets the line segment at the given index.
Public method SetAllX Set all the X values for the points to a single value (Inherited from Point3dList.)
Public method SetAllY Set all the Y values for the points to a single value (Inherited from Point3dList.)
Public method SetAllZ Set all the Z values for the points to a single value (Inherited from Point3dList.)
Public method Smooth Smoothens the polyline segments by averaging adjacent vertices. Smoothing requires a polyline with exclusively valid vertices.
Public method Sort() Sorts the elements in the entire List using the default comparer. (Inherited from RhinoList(T).)
Public method Sort(IComparer(T)) Sorts the elements in the entire list using the specified System.Comparison(T) (Inherited from RhinoList(T).)
Public method Sort(Comparison(T)) Sorts the elements in the entire list using the specified comparer. (Inherited from RhinoList(T).)
Public method Sort(Double[]) Sort this list based on a list of numeric keys of equal length. The keys array will not be altered. (Inherited from RhinoList(T).)
Public method Sort(Int32[]) Sort this list based on a list of numeric keys of equal length. The keys array will not be altered. (Inherited from RhinoList(T).)
Public method Sort(Int32, Int32, IComparer(T)) Sorts the elements in a range of elements in list using the specified comparer. (Inherited from RhinoList(T).)
Public method TangentAt Gets the unit tangent vector along the polyline at the given parameter. The integer part of the parameter indicates the index of the segment.
Public method ToArray Constructs an array that contains all items in this list. (Inherited from RhinoList(T).)
Public method ToNurbsCurve Constructs a nurbs curve representation of this polyline.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Transform Applies a transform to all the points in the list. (Inherited from Point3dList.)
Public method TriangulateClosedPolyline Attempts to create a list of triangles which represent a triangulation of a closed polyline
Public method Trim Constructs a polyline out of a parameter subdomain in this curve.
Public method TrimExcess Sets the capacity to the actual number of elements in the List, if that number is less than a threshold value. (Inherited from RhinoList(T).)
Public method TrueForAll Determines whether every element in the List matches the conditions defined by the specified predicate. (Inherited from RhinoList(T).)
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

RhinoCommon SDK

Robert McNeel and Associates

Report wishes and bugs: http://discourse.mcneel.com/

Send comments on this topic to [[email protected]](mailto:steve%40mcneel.com?Subject=RhinoCommon SDK)
⚠️ **GitHub.com Fallback** ⚠️