data class CurveRelativeVector3D: CurveRelativeAbstractGeometry3D

Represents a vector in a curve relative coordinate system in 3D. This means that only points can be referenced which are not before the curve's start or after the curve's end within the three-dimensional space.

Fields

Name Description
val curvePosition: Double

distance between the start of the curve and the point to be referenced

val lateralOffset: Double

lateral offset that is perpendicular to the curve at the curvePosition

val heightOffset: Double

additional height offset to the curve's height

Constructors

<init>

constructor(curvePosition: Double, lateralOffset: Double, heightOffset: Double)

Represents a vector in a curve relative coordinate system in 3D. This means that only points can be referenced which are not before the curve's start or after the curve's end within the three-dimensional space.

Parameters

Name Description
curvePosition: Double

distance between the start of the curve and the point to be referenced

lateralOffset: Double

lateral offset that is perpendicular to the curve at the curvePosition

heightOffset: Double

additional height offset to the curve's height

Methods

fuzzyEquals

fun fuzzyEquals(o: CurveRelativeVector3D, epsilon: Double): Boolean

Returns true, if curvePosition, lateralOffset and heightOffset are all fuzzily equal with a tolerance of epsilon.

Parameters

Name Description
o: CurveRelativeVector3D
epsilon: Double

ReturnValue

Name Description
Boolean

getCartesianCurveOffset

fun getCartesianCurveOffset(): Vector3D

ReturnValue

Name Description
Vector3D

toCurveRelative1D

fun toCurveRelative1D(): CurveRelativeVector1D

ReturnValue

Name Description
CurveRelativeVector1D

toCurveRelative2D

fun toCurveRelative2D(): CurveRelativeVector2D

ReturnValue

Name Description
CurveRelativeVector2D

CompanionObject

CurveRelativeVector3D

data class CurveRelativeVector3D: CurveRelativeAbstractGeometry3D

Represents a vector in a curve relative coordinate system in 3D. This means that only points can be referenced which are not before the curve's start or after the curve's end within the three-dimensional space.

Fields

Name Description
val ZERO: CurveRelativeVector3D

Methods

of

fun of(curvePosition: Double, lateralOffset: Double, heightOffset: Double): Result<CurveRelativeVector3D, IllegalArgumentException>

Creates a CurveRelativeVector3D by a curvePosition, lateralOffset and heightOffset. If one of the values is not finite, an error is returned.

Parameters

Name Description
curvePosition: Double
lateralOffset: Double
heightOffset: Double

ReturnValue

Name Description
Result<CurveRelativeVector3D, IllegalArgumentException>