Struct Line

Structure defining a line in three-dimensional euclidean space.
It is defined by a start point and an axis (infinite length).

Implements

IEquatable<Line>

IGeometricallyEquatable<Line>

Namespace: BRIDGES.Geometry.Euclidean3D

Assembly: BRIDGES.dll

Syntax

public struct Line : IGeometricallyEquatable<Line>

Remarks

For a finite line, refer to Segment.

Constructors

| Improve this Doc View Source

Line(Line)

Initialises a new instance of the Line structure from another Line.

Declaration

public Line(Line line)

Parameters

Type	Name	Description
Line	line	Line to copy.

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

Line(Point, Vector)

Initialises a new instance of the Line structure by defining its origin and axis.

Declaration

public Line(Point origin, Vector axis)

Parameters

Type	Name	Description
Point	origin	Origin Point of the Line.
Vector	axis	Axis of the Line.

Remarks

For a finite line, refer to Segment.

Properties

| Improve this Doc View Source

Axis

Gets or sets the axis of the current Line.

Declaration

public Vector Axis { get; set; }

Property Value

Type	Description
Vector

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

Origin

Gets or sets the origin of the current Line.

Declaration

public Point Origin { get; set; }

Property Value

Type	Description
Point

Remarks

For a finite line, refer to Segment.

Methods

| Improve this Doc View Source

Equals(Line)

Evaluates whether the current Line is memberwise equal to another Line.

Declaration

public bool Equals(Line other)

Parameters

Type	Name	Description
Line	other	Line to compare with.

Returns

Type	Description
Boolean	true if the two Line are equal, false otherwise.

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

Equals(Object)

Structure defining a line in three-dimensional euclidean space.
It is defined by a start point and an axis (infinite length).

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

Flip()

Flips the current Line by flipping its Axis.

Declaration

public void Flip()

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

GeometricallyEquals(Line)

Evaluates whether the current object is geometrically equal to the given T.

Declaration

public bool GeometricallyEquals(Line other)

Parameters

Type	Name	Description
Line	other

Returns

Type	Description
Boolean	true if the two objects are geometrically equal, false otherwise.

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

GetHashCode()

Structure defining a line in three-dimensional euclidean space.
It is defined by a start point and an axis (infinite length).

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

PointAt(Double, CurveParameterFormat)

Evaluates the current Line at the given parameter.

Declaration

public Point PointAt(double t, CurveParameterFormat format)

Parameters

Type	Name	Description
Double	t	Parameter to evaluate the Line.
CurveParameterFormat	format	Format of the parameter. Normalised The point at `t` = 1.0 is Origin + Axis. ArcLength The point at `t` = 1.0 is at distance 1.0 of Origin in the Axis direction.

Returns

Type	Description
Point	The Point on the Line at the given parameter.

Remarks

For a finite line, refer to Segment.

| Improve this Doc View Source

ToString()

Structure defining a line in three-dimensional euclidean space.
It is defined by a start point and an axis (infinite length).

Declaration

public override string ToString()

Returns

Type	Description
String

Remarks

For a finite line, refer to Segment.

Implements

IEquatable<>

IGeometricallyEquatable<T>