Polyline Class |
Polylines are closed if start and end points coincide.
Namespace: Rhino.Geometry
The Polyline type exposes the following members.
Name | Description | |
---|---|---|
Polyline |
Initializes a new empty polyline.
| |
Polyline(IEnumerablePoint3d) |
Initializes a new polyline from a collection of points.
| |
Polyline(Int32) |
Initializes a new empty polyline with an initial capacity.
|
Name | Description | |
---|---|---|
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.) | |
Capacity |
Gets or sets the total number of elements the internal data structure can hold without resizing.
(Inherited from RhinoListT.) | |
Count |
Gets the number of elements actually contained in the List.
(Inherited from RhinoListT.) | |
First |
Gets or sets the first item in the list. This is synonymous to calling List[0].
(Inherited from RhinoListT.) | |
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.
(Inherited from RhinoListT.) | |
Last |
Gets or sets the last item in the list. This is synonymous to calling List[Count-1].
(Inherited from RhinoListT.) | |
Length |
Gets the total length of the polyline.
| |
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 RhinoListT.) | |
SegmentCount |
Gets the number of segments for this polyline.
| |
X |
Returns an indexer with all X coordinates in this list.
(Inherited from Point3dList.) | |
Y |
Returns an indexer with all Y coordinates in this list.
(Inherited from Point3dList.) | |
Z |
Returns an indexer with all Z coordinates in this list.
(Inherited from Point3dList.) |
Name | Description | |
---|---|---|
Add(T) |
Adds an object to the end of the List.
(Inherited from RhinoListT.) | |
Add(Double, Double, Double) |
Adds a Point3d to the end of the list with given x,y,z coordinates.
(Inherited from Point3dList.) | |
AddRange(IEnumerable) |
Adds the elements of the specified collection to the end of the List.
(Inherited from RhinoListT.) | |
AddRange(IEnumerableT) |
Adds the elements of the specified collection to the end of the List.
(Inherited from RhinoListT.) | |
AsReadOnly |
Constructs a read-only wrapper of this class.
(Inherited from RhinoListT.) | |
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 RhinoListT.) | |
BinarySearch(T, IComparerT) |
Searches the entire sorted List for an element using the specified
comparer and returns the zero-based index of the element.
(Inherited from RhinoListT.) | |
BinarySearch(Int32, Int32, T, IComparerT) |
Searches the entire sorted List for an element using the specified
comparer and returns the zero-based index of the element.
(Inherited from RhinoListT.) | |
BreakAtAngles |
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.
(Inherited from RhinoListT.) | |
ClosestIndex |
Finds the index of the point that is closest to a test point in this list.
(Inherited from Point3dList.) | |
ClosestParameter |
Gets the parameter along the polyline which is closest to a test-point.
| |
ClosestPoint |
Gets the point on the polyline which is closest to a test-point.
| |
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.
| |
Contains |
Determines whether an element is in the List.
(Inherited from RhinoListT.) | |
ConvertAllTOutput |
Aggregates all results of a conversion function over this table into a new list.
(Inherited from RhinoListT.) | |
CopyTo(T) |
Copies the entire List to a compatible one-dimensional array,
starting at the beginning of the target array.
(Inherited from RhinoListT.) | |
CopyTo(T, Int32) |
Copies the entire List to a compatible one-dimensional array,
starting at the specified index of the target array.
(Inherited from RhinoListT.) | |
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 RhinoListT.) | |
CreateByJoiningLines |
Creates polylines by joining lines.
| |
CreateCircumscribedPolygon |
Create a regular polygon circumscribe about a circle. The midpoints of the polygon's edges will be tangent to the circle.
| |
CreateInscribedPolygon |
Create a regular polygon inscribed in a circle. The vertices of the polygon will be on the circle.
| |
CreateStarPolygon |
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 |
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.
| |
Equals(Object) |
Overrides the default object equality to compare lists by value.
(Inherited from Point3dList.) | |
Equals(Point3dList) |
Determines if the point lists are exactly equal.
(Inherited from Point3dList.) | |
Exists |
Determines whether the List contains elements that match the
conditions defined by the specified predicate.
(Inherited from RhinoListT.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
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 RhinoListT.) | |
FindAll |
Retrieves all the elements that match the conditions defined by the specified predicate.
(Inherited from RhinoListT.) | |
FindIndex(PredicateT) |
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 RhinoListT.) | |
FindIndex(Int32, PredicateT) |
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 RhinoListT.) | |
FindIndex(Int32, Int32, PredicateT) |
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 RhinoListT.) | |
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 RhinoListT.) | |
FindLastIndex(PredicateT) |
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 RhinoListT.) | |
FindLastIndex(Int32, PredicateT) |
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 RhinoListT.) | |
FindLastIndex(Int32, Int32, PredicateT) |
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 RhinoListT.) | |
ForEach |
Performs the specified action on each element of the List.
(Inherited from RhinoListT.) | |
GetEnumerator |
Constructs an enumerator that is capable of iterating over all items in this list.
(Inherited from RhinoListT.) | |
GetHashCode |
Creates a hash code for this object.
(Inherited from Point3dList.) | |
GetRange |
Constructs a shallow copy of a range of elements in the source List.
(Inherited from RhinoListT.) | |
GetSegments |
Constructs an array of line segments that make up the entire polyline.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IndexOf(T) |
Searches for the specified object and returns the zero-based index of the
first occurrence within the entire List.
(Inherited from RhinoListT.) | |
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 RhinoListT.) | |
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 RhinoListT.) | |
Insert |
Inserts an element into the List at the specified index.
(Inherited from RhinoListT.) | |
InsertRange |
Inserts the elements of a collection into the List at the specified index.
(Inherited from RhinoListT.) | |
IsClosedWithinTolerance |
Test a polyline to see if it is closed.
| |
LastIndexOf(T) |
Searches for the specified object and returns the zero-based
index of the last occurrence within the entire List.
(Inherited from RhinoListT.) | |
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 RhinoListT.) | |
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 RhinoListT.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MergeColinearSegments |
Merge co-linear consecutive segments in a polyline.
This method will automatically remove any zero-length segments as well.
| |
PointAt |
Gets the point on the polyline at the given parameter.
The integer part of the parameter indicates the index of the segment.
| |
ReduceSegments |
Constructs a reduction of this polyline by recursively removing the least significant segments.
| |
RemapIndex |
Remap an index in the infinite range onto the List index range.
(Inherited from RhinoListT.) | |
Remove |
Removes the first occurrence of a specific object from the List.
(Inherited from RhinoListT.) | |
RemoveAll |
Removes the all the elements that match the conditions defined by the specified predicate.
(Inherited from RhinoListT.) | |
RemoveAt |
Removes the element at the specified index of the List.
(Inherited from RhinoListT.) | |
RemoveNearlyEqualSubsequentPoints |
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 null references (Nothing in Visual Basic).
This function will not do anything if T is not a Reference type.
(Inherited from RhinoListT.) | |
RemoveRange |
Removes a range of elements from the List.
(Inherited from RhinoListT.) | |
Reverse |
Reverses the order of the elements in the entire List.
(Inherited from RhinoListT.) | |
Reverse(Int32, Int32) |
Reverses the order of the elements in the specified range.
(Inherited from RhinoListT.) | |
SegmentAt |
Gets the line segment at the given index.
| |
SetAllX |
Set all the X values for the points to a single value
(Inherited from Point3dList.) | |
SetAllY |
Set all the Y values for the points to a single value
(Inherited from Point3dList.) | |
SetAllZ |
Set all the Z values for the points to a single value
(Inherited from Point3dList.) | |
Smooth |
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.
(Inherited from RhinoListT.) | |
Sort(ComparisonT) |
Sorts the elements in the entire list using the specified comparer.
(Inherited from RhinoListT.) | |
Sort(Double) |
Sort this list based on a list of numeric keys of equal length.
The keys array will not be altered.
(Inherited from RhinoListT.) | |
Sort(IComparerT) |
Sorts the elements in the entire list using the specified System.Comparison(T)
(Inherited from RhinoListT.) | |
Sort(Int32) |
Sort this list based on a list of numeric keys of equal length.
The keys array will not be altered.
(Inherited from RhinoListT.) | |
Sort(Int32, Int32, IComparerT) |
Sorts the elements in a range of elements in list using the specified comparer.
(Inherited from RhinoListT.) | |
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.
| |
ToArray |
Constructs an array that contains all items in this list.
(Inherited from RhinoListT.) | |
ToNurbsCurve |
Constructs a nurbs curve representation of this polyline.
| |
ToPolylineCurve |
Constructs a polyline curve representation of this polyline.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Transform |
Applies a transform to all the points in the list.
(Inherited from Point3dList.) | |
TriangulateClosedPolyline |
Attempts to create a list of triangles which represent a
triangulation of a closed polyline
| |
Trim |
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.
(Inherited from RhinoListT.) | |
TrueForAll |
Determines whether every element in the List matches the conditions defined by the specified predicate.
(Inherited from RhinoListT.) |