MathKit/com.sztorm.mathkit.euclidean2d/LineSegment

LineSegment

Represents a transformable line segment in a two-dimensional Euclidean space.

Implementations that use default-implemented members of this interface must make sure that the properties center, orientation, length and the copy method are independent of other members and the computational complexity of these members is trivial.

Inheritors

MutableLineSegment

Properties

center

abstract val center: Vector2F

Returns the center of this line segment.

length

abstract val length: Float

Returns the length of this line segment.

orientation

abstract override val orientation: ComplexF

Returns the orientation of this object in reference to the origin of ComplexF.ONE.

pointA

open val pointA: Vector2F

Returns the point A of this line segment.

pointB

open val pointB: Vector2F

Returns the point B of this line segment.

position

open override val position: Vector2F

Returns the position of this object in reference to the origin of Vector2F.ZERO.

Functions

closestPointTo

open fun closestPointTo(point: Vector2F): Vector2F

Returns the closest point on this line segment to the given point.

component1

open operator fun component1(): Vector2F

Returns the center of this line segment.

component2

open operator fun component2(): ComplexF

Returns the orientation of this line segment.

component3

open operator fun component3(): Float

Returns the length of this line segment.

contains

open operator fun contains(point: Vector2F): Boolean

Returns true if this line segment approximately contains the given point.

copy

abstract fun copy(center: Vector2F = this.center, orientation: ComplexF = this.orientation, length: Float = this.length): LineSegment

Returns a copy of this instance with specified properties changed.

dilatedBy

open override fun dilatedBy(point: Vector2F, factor: Float): LineSegment

Returns a copy of this object that is dilated around the point by a factor.

interpolated

open fun interpolated(to: LineSegment, by: Float): LineSegment

Returns a copy of this line segment interpolated to other line segment by a factor.

intersects

open fun intersects(ray: Ray): Boolean

Returns true if this line segment intersects the given ray.

movedBy

open override fun movedBy(displacement: Vector2F): LineSegment

Returns a copy of this object that is moved by a displacement.

movedTo

open override fun movedTo(position: Vector2F): LineSegment

Returns a copy of this object that is moved to the position.

pointIterator

open fun pointIterator(): Vector2FIterator

Creates an iterator over the points of this line segment.

rotatedAroundPointBy

open override fun rotatedAroundPointBy(point: Vector2F, rotation: AngleF): LineSegment

open override fun rotatedAroundPointBy(point: Vector2F, rotation: ComplexF): LineSegment

Returns a copy of this object that is rotated around the point by a rotation.

rotatedAroundPointTo

open override fun rotatedAroundPointTo(point: Vector2F, orientation: AngleF): LineSegment

open override fun rotatedAroundPointTo(point: Vector2F, orientation: ComplexF): LineSegment

Returns a copy of this object that is rotated around the point to the orientation.

rotatedBy

open override fun rotatedBy(rotation: AngleF): LineSegment

open override fun rotatedBy(rotation: ComplexF): LineSegment

Returns a copy of this object that is rotated by a rotation.

rotatedTo

open override fun rotatedTo(orientation: AngleF): LineSegment

open override fun rotatedTo(orientation: ComplexF): LineSegment

Returns a copy of this object that is rotated to the orientation.

scaledBy

open override fun scaledBy(factor: Float): LineSegment

Returns a copy of this object that is scaled by a factor.

transformedBy

open override fun transformedBy(displacement: Vector2F, rotation: AngleF): LineSegment

open override fun transformedBy(displacement: Vector2F, rotation: ComplexF): LineSegment

Returns a copy of this object that is moved by a displacement and rotated by a rotation.

open override fun transformedBy(displacement: Vector2F, rotation: AngleF, scaleFactor: Float): LineSegment

open override fun transformedBy(displacement: Vector2F, rotation: ComplexF, scaleFactor: Float): LineSegment

Returns a copy of this object that is moved by a displacement, rotated by a rotation, and scaled by a scaleFactor.

transformedTo

open override fun transformedTo(position: Vector2F, orientation: AngleF): LineSegment

open override fun transformedTo(position: Vector2F, orientation: ComplexF): LineSegment

Returns a copy of this object that is moved to the position and rotated to the orientation.