Struct Ray

Structure defining a half-line in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length). For an infinite line, refer to Line.

Namespace: BRIDGES.Geometry.Euclidean3D
Assembly: BRIDGES.dll
Syntax
public struct Ray

Constructors

| Improve this Doc View Source

Ray(Point, Vector)

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

Declaration
public Ray(Point start, Vector axis)
Parameters
Type Name Description
Point start

Start Point of the Ray.
Vector axis

Axis of the Ray.
| Improve this Doc View Source

Ray(Ray)

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

Declaration
public Ray(Ray ray)
Parameters
Type Name Description
Ray ray

Ray to copy.

Properties

| Improve this Doc View Source

Axis

Gets the axis of the current Ray.

Declaration
public Vector Axis { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

StartPoint

Gets the start Point of the current Ray.

Declaration
public Point StartPoint { get; set; }
Property Value
Type Description
Point

Methods

| Improve this Doc View Source

Equals(Ray)

Evaluates whether the current Ray is equal to another Ray.

Declaration
public bool Equals(Ray other)
Parameters
Type Name Description
Ray other

Ray to compare with.
Returns
Type Description
Boolean

true if the two Ray are equal, false otherwise.
Remarks

Two Ray are equal if their start Point are equal and their Vector axis parallel.

| Improve this Doc View Source

Equals(Object)

Structure defining a half-line in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length). For an infinite line, refer to Line.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
| Improve this Doc View Source

Flip()

Flips the current Ray by flipping the Axis.

Declaration
public void Flip()
| Improve this Doc View Source

GetHashCode()

Structure defining a half-line in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length). For an infinite line, refer to Line.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
| Improve this Doc View Source

PointAt(Double)

Evaluates the current Ray at the given length parameter.

Declaration
public Point PointAt(double lengthParameter)
Parameters
Type Name Description
Double lengthParameter

Value of the length parameter.
Returns
Type Description
Point

The Point on the Line at the given length parameter.
| Improve this Doc View Source

ToString()

Structure defining a half-line in three-dimensional euclidean space.
It is defined by a start point and an end point (finite length). For an infinite line, refer to Line.

Declaration
public override string ToString()
Returns
Type Description
String