Class PolyLine
A simple data structure representing a polyline.
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Syntax
public class PolyLine : NurbsBase, IGeometry<NurbsBase>, IEquatable<NurbsBase>, ITransformable<NurbsBase>, IGeometry<PolyLine>, IEquatable<PolyLine>, ITransformable<PolyLine>Examples
ExamplePts = new[]
{
new Point3(5, 0, 0),
new Point3(15, 15, 0),
new Point3(20, 5, 0),
new Point3(30, 10, 0),
new Point3(45, 12.5, 0)
};
_polyLine = new PolyLine(ExamplePts);
Constructors
| Improve this Doc View SourcePolyLine(IList<Point3>)
Initializes a new polyline from a collection of points.
Declaration
public PolyLine(IList<Point3> vertices)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<Point3> | vertices | Points used to create the polyline. |
Properties
| Improve this Doc View SourceEndPoint
Gets the end point of the polyline.
Declaration
public override Point3 EndPoint { get; }Property Value
| Type | Description |
|---|---|
| Point3 |
Overrides
| Improve this Doc View SourceIsClosed
Gets true if the polyline is closed. A polyline is considered closed, if its start and end point are identical.
Declaration
public override bool IsClosed { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
| Improve this Doc View SourceLength
Calculates the length of the polyline.
Declaration
public override double Length { get; }Property Value
| Type | Description |
|---|---|
| System.Double | The total length of the polyline. |
Overrides
| Improve this Doc View SourceMidPoint
Gets the middle point of the polyline.
Declaration
public override Point3 MidPoint { get; }Property Value
| Type | Description |
|---|---|
| Point3 |
Overrides
| Improve this Doc View SourceSegments
Constructs a collections of lines, which make the polyline.
Declaration
public List<Line> Segments { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<Line> | A collection of lines. |
SegmentsCount
Gets the number of segments for this polyline;
Declaration
public int SegmentsCount { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
StartPoint
Gets the starting point of the polyline.
Declaration
public override Point3 StartPoint { get; }Property Value
| Type | Description |
|---|---|
| Point3 |
Overrides
Methods
| Improve this Doc View SourceClose()
Creates a closed polyline, where the first and last point are the same.
Declaration
public PolyLine Close()Returns
| Type | Description |
|---|---|
| PolyLine | A closed polyline. |
ClosestParameter(Point3)
Gets the parameter along the polyline which is closest to the test point.
Declaration
public override double ClosestParameter(Point3 pt)Parameters
| Type | Name | Description |
|---|---|---|
| Point3 | pt | The point to test. |
Returns
| Type | Description |
|---|---|
| System.Double | The parameter closest to the test point. |
Overrides
| Improve this Doc View SourceClosestPoint(Point3)
Computes the point which is the closest point to the given point.
Declaration
public override Point3 ClosestPoint(Point3 pt)Parameters
| Type | Name | Description |
|---|---|---|
| Point3 | pt | Point to test. |
Returns
| Type | Description |
|---|---|
| Point3 | The point closest to the given point. |
Overrides
| Improve this Doc View SourceEquals(PolyLine)
Checks if a polyline is equal to the provided polyline.
Two polyline are equal if all the points are the same.
Declaration
public bool Equals(PolyLine other)Parameters
| Type | Name | Description |
|---|---|---|
| PolyLine | other | The polyline to compare. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the points are equal, otherwise false. |
GetBoundingBox()
Computes the bounding box of the list of points.
Declaration
public override BoundingBox GetBoundingBox()Returns
| Type | Description |
|---|---|
| BoundingBox | The bounding box. |
Overrides
| Improve this Doc View SourceLengthAt(Double)
Evaluated the length on the polyline at the given parameter.
Declaration
public override double LengthAt(double t)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | t | Evaluate parameter. Parameter should be between 0.0 and segments count. |
Returns
| Type | Description |
|---|---|
| System.Double | The evaluated length at the curve parameter. |
Overrides
| Improve this Doc View SourceOffset(Double, Plane)
Computes the offset of the polyline.
Declaration
public PolyLine Offset(double distance, Plane pln)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | distance | The distance of the offset. If negative the offset will be in the opposite side. |
| Plane | pln | The plane for the offset operation. |
Returns
| Type | Description |
|---|---|
| PolyLine | The offset polyline. |
ParameterAtLength(Double)
Calculates the parameter of the polyline at the given length.
Declaration
public override double ParameterAtLength(double length)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | length | Length from start of polyline. |
Returns
| Type | Description |
|---|---|
| System.Double | The parameter at the given length. |
Overrides
| Improve this Doc View SourcePointAt(Double)
Evaluates the point on the polyline at the given parameter. The integer part of the parameter indicates the index of the segment.
Declaration
public override Point3 PointAt(double t)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | t | Evaluate parameter. Parameter should be between 0.0 and segments count. |
Returns
| Type | Description |
|---|---|
| Point3 | The evaluated point at the curve parameter. |
Overrides
| Improve this Doc View SourcePointAtLength(Double)
Declaration
public override Point3 PointAtLength(double length)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | length |
Returns
| Type | Description |
|---|---|
| Point3 |
Overrides
| Improve this Doc View SourcePointAtNormalizedLength(Double)
Evaluates a point at the normalized length.
Declaration
public override Point3 PointAtNormalizedLength(double normalizedLength)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | normalizedLength | The length factor is normalized between 0.0 and 1.0. |
Returns
| Type | Description |
|---|---|
| Point3 | The point at the length. |
Overrides
| Improve this Doc View SourceReverse()
Reverses the order of the polyline.
Declaration
public PolyLine Reverse()Returns
| Type | Description |
|---|---|
| PolyLine | A polyline reversed. |
SegmentAtLength(Double)
Returns the index of the segment at a given length along the polyline.
Declaration
public Line SegmentAtLength(double length)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | length | Length from start of polyline. |
Returns
| Type | Description |
|---|---|
| Line | Zero based index of polyline segment. |
ToString()
Constructs the string representation of the polyline.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A text string. |
Overrides
| Improve this Doc View SourceTransform(TransformMatrix)
Applies a transformation to all the points.
Declaration
public PolyLine Transform(TransformMatrix transform)Parameters
| Type | Name | Description |
|---|---|---|
| TransformMatrix | transform | Transformation matrix to apply. |
Returns
| Type | Description |
|---|---|
| PolyLine | A polyline transformed. |
Implements
System.IEquatable<T>
System.IEquatable<T>