Struct Segment

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Namespace: BRIDGES.Geometry.Euclidean3D

Assembly: BRIDGES.dll

Syntax

public struct Segment

Remarks

For an infinite line, refer to Line.

Constructors

| Improve this Doc View Source

Segment(Point, Point)

Initialises a new instance of the Segment structure by defining its start and end Point.

Declaration

public Segment(Point start, Point end)

Parameters

Type	Name	Description
Point	start	Start Point of the Segment.
Point	end	End Point of the Segment.

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

Segment(Segment)

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

Declaration

public Segment(Segment segment)

Parameters

Type	Name	Description
Segment	segment	Segment to copy.

Remarks

For an infinite line, refer to Line.

Properties

| Improve this Doc View Source

DomainEnd

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public readonly double DomainEnd { get; }

Property Value

Type	Description
Double

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

DomainStart

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public readonly double DomainStart { get; }

Property Value

Type	Description
Double

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

EndPoint

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public Point EndPoint { get; set; }

Property Value

Type	Description
Point

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

IsClosed

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public readonly bool IsClosed { get; }

Property Value

Type	Description
Boolean

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

StartPoint

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public Point StartPoint { get; set; }

Property Value

Type	Description
Point

Remarks

For an infinite line, refer to Line.

Methods

| Improve this Doc View Source

Equals(Segment)

Evaluates whether the current Segment is equal to another Segment.

Declaration

public bool Equals(Segment other)

Parameters

Type	Name	Description
Segment	other	Segment to compare with.

Returns

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

Remarks

Two Segment are equal if their start and end Point are equal.

| Improve this Doc View Source

Equals(Object)

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

Flip()

Flips the current Segment by inverting the StartPoint and the EndPoint.

Declaration

public void Flip()

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

GetHashCode()

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

Length()

Computes the length of the current Segment.

Declaration

public double Length()

Returns

Type	Description
Double	The value corresponding to the Segment's length.

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

PointAt(Double, CurveParameterFormat)

Evaluates the current Segment at the given parameter.

Declaration

public Point PointAt(double parameter, CurveParameterFormat format)

Parameters

Type	Name	Description
Double	parameter	Value of the parameter.
CurveParameterFormat	format	Format of the parameter.

Returns

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

Remarks

For an infinite line, refer to Line.

| Improve this Doc View Source

ToString()

Structure defining a segment curve in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length).

Declaration

public override string ToString()

Returns

Type	Description
String

Remarks

For an infinite line, refer to Line.