Class Line
A curve representing a straight line.
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 Line : NurbsBase, IGeometry<NurbsBase>, IEquatable<NurbsBase>, ITransformable<NurbsBase>, IGeometry<Line>, IEquatable<Line>, ITransformable<Line>Examples
// Initializes a line by start and end point.
Point3 pt1 = new Point3(5, 0, 0);
Point3 pt2 = new Point3(15, 15, 0);
_exampleLine = new Line(pt1, pt2);
// Initializes a line by a starting point a direction and a length.
Line line = new Line(pt1, Vector3.XAxis, 15);
Constructors
| Improve this Doc View SourceLine(Point3, Point3)
Initializes a line by start point and end point.
Declaration
public Line(Point3 startPoint, Point3 endPoint)Parameters
| Type | Name | Description |
|---|---|---|
| Point3 | startPoint | Start point. |
| Point3 | endPoint | End point. |
Line(Point3, Vector3, Double)
Initializes a line from a starting point, direction and length.
Declaration
public Line(Point3 startPoint, Vector3 direction, double length)Parameters
| Type | Name | Description |
|---|---|---|
| Point3 | startPoint | Starting point of the line. |
| Vector3 | direction | Direction of the line. |
| System.Double | length | Length of the line. |
Properties
| Improve this Doc View SourceDirection
Unit vector representing direction of the line.
Declaration
public Vector3 Direction { get; }Property Value
| Type | Description |
|---|---|
| Vector3 |
EndPoint
Gets the end point of the line.
Declaration
public override Point3 EndPoint { get; }Property Value
| Type | Description |
|---|---|
| Point3 |
Overrides
| Improve this Doc View SourceLength
Length of the line.
Declaration
public override double Length { get; }Property Value
| Type | Description |
|---|---|
| System.Double |
Overrides
| Improve this Doc View SourceMidPoint
Gets the middle point of the line.
Declaration
public override Point3 MidPoint { get; }Property Value
| Type | Description |
|---|---|
| Point3 |
Overrides
| Improve this Doc View SourceStartPoint
Gets the start point of the line.
Declaration
public override Point3 StartPoint { get; }Property Value
| Type | Description |
|---|---|
| Point3 |
Overrides
Methods
| Improve this Doc View SourceClosestParameter(Point3)
Computes the parameter on the line that is closest to a test point.
Declaration
public override double ClosestParameter(Point3 point)Parameters
| Type | Name | Description |
|---|---|---|
| Point3 | point | The test point. |
Returns
| Type | Description |
|---|---|
| System.Double | The parameter on the line closest to the test point. |
Overrides
| Improve this Doc View SourceClosestPoint(Point3)
Gets the closest point on the line to the test point.
Declaration
public override Point3 ClosestPoint(Point3 point)Parameters
| Type | Name | Description |
|---|---|---|
| Point3 | point | The closest point to find. |
Returns
| Type | Description |
|---|---|
| Point3 | The point on the line closest to the test point. |
Overrides
| Improve this Doc View SourceEquals(Line)
Checks if the line is equal to the provided line.
Two lines are equal if the end points are the same.
Declaration
public bool Equals(Line other)Parameters
| Type | Name | Description |
|---|---|---|
| Line | other | The line to compare. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the end points are equal, otherwise false. |
Equals(Object)
Checks if the line is equal to the provided line.
Two lines are equal if the end points are the same.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The curve object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Return true if the nurbs curves are equal. |
Overrides
| Improve this Doc View SourceExtend(Double, Double)
Extends the line by lengths on both side.
Declaration
public Line Extend(double startLength, double endLength)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | startLength | Length to extend the line at the start point. |
| System.Double | endLength | Length to extend the line at the end point. |
Returns
| Type | Description |
|---|---|
| Line | The extended line. |
GetBoundingBox()
Gets the bounding box in ascending fashion.
Declaration
public override BoundingBox GetBoundingBox()Returns
| Type | Description |
|---|---|
| BoundingBox |
Overrides
| Improve this Doc View SourceGetHashCode()
Gets the hash code for the line.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | A unique hashCode of an line. |
Overrides
| Improve this Doc View SourceLengthAt(Double)
Returns the length at a given parameter.
Declaration
public override double LengthAt(double t)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | t | Parameter, between 0.0 and 1.0. |
Returns
| Type | Description |
|---|---|
| System.Double | The curve length at parameter. |
Overrides
| Improve this Doc View SourceOffset(Double, Plane)
Computes the offset of the line.
Declaration
public Line 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 |
|---|---|
| Line | The offset line. |
PointAt(Double)
Evaluates the line at the specified parameter.
Declaration
public override Point3 PointAt(double t)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | t | Parameter to evaluate the line. Parameter should be between 0.0 and 1.0. |
Returns
| Type | Description |
|---|---|
| Point3 | The point at the specific parameter. |
Overrides
| Improve this Doc View SourcePointAtLength(Double)
Evaluates the point on the curve at a given length.
Declaration
public override Point3 PointAtLength(double length)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | length | Length, between 0.0 and the length of the curve. |
Returns
| Type | Description |
|---|---|
| Point3 | The point at the given length. |
Overrides
| Improve this Doc View SourceReverse()
Flip the endpoint of the line.
Declaration
public Line Reverse()Returns
| Type | Description |
|---|---|
| Line | The line flipped. |
ToString()
Constructs the string representation of the line.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A text string. |
Overrides
| Improve this Doc View SourceTransform(TransformMatrix)
Transforms the line using the transformation matrix.
Declaration
public Line Transform(TransformMatrix t)Parameters
| Type | Name | Description |
|---|---|---|
| TransformMatrix | t | Transformation matrix to apply. |
Returns
| Type | Description |
|---|---|
| Line | A line transformed. |
Implements
System.IEquatable<T>
System.IEquatable<T>