Line

Line struct

Represents the value of start and end points in a single line segment.

Derived Classes:

Namespace: Rhino.Geometry
Line: references

Constructors (4)

Line(double x0, double y0, double z0, double x1, double y1, double z1)

Constructs a new line segment between two points.

Line(Point3d from, Point3d to)

Constructs a new line segment between two points.

Line(Point3d start, Vector3d direction, double length)

Constructs a new line segment from start point, direction and length.

Line(Point3d start, Vector3d span)

Constructs a new line segment from start point and span vector.

Properties (14)

BoundingBox

Gets the line's 3d axis aligned bounding box.

Direction

Gets the direction of this line segment. The length of the direction vector equals the length of the line segment.

From

Start point of line segment.

FromX

Gets or sets the X coordinate of the line From point.

FromY

Gets or sets the Y coordinate of the line From point.

FromZ

Gets or sets the Z coordinate of the line From point.

IsValid

Gets a value indicating whether or not this line is valid. Valid lines must have valid start and end points, and the points must not be equal.

Length

Gets or sets the length of this line segment. Note that a negative length will invert the line segment without making the actual length negative. The line From point will remain fixed when a new Length is set.

End point of line segment.

ToX

Gets or sets the X coordinate of the line To point.

ToY

Gets or sets the Y coordinate of the line To point.

ToZ

Gets or sets the Z coordinate of the line To point.

UnitTangent

Gets the tangent of the line segment. Note that tangent vectors are always unit vectors.

Unset

Gets a line segment which has <b>Point3d.Unset</b> end points.

Methods (26)

ClosestParameter(Point3d testPoint)

Finds the parameter on the infinite line segment that is closest to a test point.

ClosestPoint(Point3d testPoint, bool limitToFiniteSegment)

Finds the point on the (in)finite line segment that is closest to a test point.

DistanceTo(Point3d testPoint, bool limitToFiniteSegment)

Compute the shortest distance between this line segment and a test point.

EpsilonEquals(Line other, double epsilon)

Check that all values in other are within epsilon of the values in this

Equals(Line other)

Determines whether a line has the same value as this line.

Equals(object obj)

Determines whether an object is a line that has the same value as this line.

Extend(double startLength, double endLength)

Extend the line by custom distances on both sides.

ExtendThroughBox(BoundingBox box, double additionalLength)

Ensure the line extends all the way through a box. Note, this does not result in the shortest possible line that overlaps the box.

ExtendThroughBox(BoundingBox box)

Ensure the line extends all the way through a box. Note, this does not result in the shortest possible line that overlaps the box.

ExtendThroughBox(Box box, double additionalLength)

Ensure the line extends all the way through a box. Note, this does not result in the shortest possible line that overlaps the box.

ExtendThroughBox(Box box)

Ensure the line extends all the way through a box. Note, this does not result in the shortest possible line that overlaps the box.

Flip()

Flip the endpoints of the line segment.

GetHashCode()

Computes a hash number that represents this line.

MaximumDistanceTo(Line testLine)

Finds the largest distance between this line as a finite segment and another finite segment.

MaximumDistanceTo(Point3d testPoint)

Finds the largest distance between this line as a finite segment and a test point.

MinimumDistanceTo(Line testLine)

Finds the shortest distance between this line as a finite segment and another finite segment.

MinimumDistanceTo(Point3d testPoint)

Finds the shortest distance between this line as a finite segment and a test point.

PointAt(double t)

Evaluates the line at the specified parameter.

PointAtLength(double distance)

Computes a point located at a specific metric distance from the line origin ( <b>From</b> ).
If line start and end coincide, then the start point is always returned.

ToNurbsCurve()

Constructs a nurbs curve representation of this line. This amounts to the same as calling NurbsCurve.CreateFromLine().

ToString()

Constructs the string representation of this line, in the form "From,To".

ToString(string format,IFormatProvider formatProvider)

Transform(Transform xform)

Transform the line using a Transformation matrix.

TryCreateBetweenCurves(Curve curve0, Curve curve1, ref double t0, ref double t1, bool perpendicular0, bool perpendicular1, out Line line)

Creates a line segment between a pair of curves such that the line segment is either tangent or perpendicular to each of the curves.

TryFitLineToPoints(IEnumerable<Point3d> points, out Line fitLine)

Attempt to fit a line through a set of points.

TryGetPlane(out Plane plane)

Gets a plane that contains the line. The origin of the plane is at the start of the line. If possible, a plane parallel to the world XY, YZ, or ZX plane is returned.

Operators (2)

Determines whether two lines have different values.

Determines whether two lines have the same value.

Nothing found