rtron-math/io.rtron.math.geometry.euclidean.threed.curve/LineSegment3D

LineSegment3D

class LineSegment3D(val start: Vector3D, val end: Vector3D, val tolerance: Double, endBoundType: BoundType = BoundType.CLOSED) : AbstractCurve3D

Line segment in 3D defined by a start and end vector.

Parameters

start

start of the line segment

end

end of the line segment

endBoundType
tolerance

allowed tolerance

Constructors

Link copied to clipboard
constructor(start: Vector3D, end: Vector3D, tolerance: Double, endBoundType: BoundType = BoundType.CLOSED)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open val affineSequence: AffineSequence3D

List of affine transformation matrices to move and rotate the geometric object.

Link copied to clipboard
val direction: Vector3D

direction of the line segment as normalized vector

Link copied to clipboard
open override val domain: Range<Double>

definable domain

Link copied to clipboard
val end: Vector3D
Link copied to clipboard
val endBoundType: BoundType

BoundType at the end of the curve

Link copied to clipboard
val length: Double

Length of the curve

Link copied to clipboard
Link copied to clipboard
open override val tolerance: Double
Link copied to clipboard
val vertices: List<Vector3D>

start and end vertices of the line segment as list

Functions

Link copied to clipboard
open override fun accept(visitor: Geometry3DVisitor)

Accepting function so that a geometry visitor can pass by.

Link copied to clipboard
fun calculateEndPointGlobalCS(): Either<GeometryException.ValueNotContainedInDomain, Vector3D>

Returns the end point in the global cartesian coordinate system that is located on this curve.

Link copied to clipboard
fun calculateLineStringGlobalCS(step: Double): Either<GeometryException, LineString3D>

Returns a discretized curve as a LineString3D.

Link copied to clipboard
fun calculatePointGlobalCS(curveRelativePoint: CurveRelativeVector1D): Either<GeometryException.ValueNotContainedInDomain, Vector3D>

Returns the point in the global cartesian coordinate system that is located on this curve and given by a point in the curve relative coordinate system. An error is returned, if the requested point is not within this curve's domain.

Link copied to clipboard
fun calculatePointGlobalCSUnbounded(curveRelativePoint: CurveRelativeVector1D): Vector3D

Returns the point in the global cartesian coordinate system that is located on this curve and given by a point in the curve relative coordinate system.

Link copied to clipboard
fun calculatePointListGlobalCS(step: Double, includeEndPoint: Boolean = true): Either<GeometryException.ValueNotContainedInDomain, NonEmptyList<Vector3D>>

Returns a list of points on the curve with a step size of step.

Link copied to clipboard
fun calculatePointLocalCS(curveRelativePoint: CurveRelativeVector1D): Either<GeometryException, Vector3D>

Returns the point in the local cartesian coordinate system that is located on this curve and given by a point in the curve relative coordinate system. An error is returned, if the requested point is not within this curve's domain.

Link copied to clipboard
fun calculateStartPointGlobalCS(): Either<GeometryException.ValueNotContainedInDomain, Vector3D>

Returns the start point in the global cartesian coordinate system that is located on this curve.

Link copied to clipboard
fun distance(point: Vector3D): Double

Returns the distance between this line segment and a given point. For more, see StackOverflow

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int