MathKit/com.sztorm.mathkit.euclidean2d/MutableLineSegment

MutableLineSegment

class MutableLineSegment : LineSegment, MutableTransformable

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

Constructors

MutableLineSegment

constructor(center: Vector2F, orientation: ComplexF, length: Float)

Creates a new instance of MutableLineSegment.

constructor(pointA: Vector2F, pointB: Vector2F)

Creates a new instance of MutableLineSegment.

Types

Companion

object Companion

Properties

center

open override val center: Vector2F

Returns the center of this line segment.

length

open override val length: Float

Returns the length of this line segment.

orientation

open override val orientation: ComplexF

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

pointA

open override val pointA: Vector2F

Returns the point A of this line segment.

pointB

open override 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

calibrate

fun calibrate()

Calibrates the properties of this instance. If the orientation cannot be normalized, it will take the value of ONE.

closestPointTo

open override fun closestPointTo(point: Vector2F): Vector2F

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

component1

open operator override fun component1(): Vector2F

Returns the center of this line segment.

component2

open operator override fun component2(): ComplexF

Returns the orientation of this line segment.

component3

open operator override fun component3(): Float

Returns the length of this line segment.

contains

open operator override fun contains(point: Vector2F): Boolean

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

copy

open override fun copy(center: Vector2F, orientation: ComplexF, length: Float): MutableLineSegment

Returns a copy of this instance with specified properties changed.

dilateBy

open override fun dilateBy(point: Vector2F, factor: Float)

Dilates this object around the point by a factor.

dilatedBy

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

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

equals

fun equals(other: MutableLineSegment): Boolean

Indicates whether the other MutableLineSegment is equal to this one.

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

interpolate

fun interpolate(from: LineSegment, to: LineSegment, by: Float)

Sets this line segment with the result of interpolation from one line segment to another line segment by a factor.

interpolated

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

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

intersects

open override fun intersects(ray: Ray): Boolean

Returns true if this line segment intersects the given ray.

moveBy

open override fun moveBy(displacement: Vector2F)

Moves this object by a displacement.

movedBy

open override fun movedBy(displacement: Vector2F): MutableLineSegment

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

movedTo

open override fun movedTo(position: Vector2F): MutableLineSegment

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

moveTo

open override fun moveTo(position: Vector2F)

Moves this object to the position.

pointIterator

open override fun pointIterator(): Vector2FIterator

Creates an iterator over the points of this line segment.

rotateAroundPointBy

open override fun rotateAroundPointBy(point: Vector2F, rotation: AngleF)

open override fun rotateAroundPointBy(point: Vector2F, rotation: ComplexF)

Rotates this object around the point by a rotation.

rotateAroundPointTo

open override fun rotateAroundPointTo(point: Vector2F, orientation: AngleF)

open override fun rotateAroundPointTo(point: Vector2F, orientation: ComplexF)

Rotates this object around the point to the orientation.

rotateBy

open override fun rotateBy(rotation: AngleF)

open override fun rotateBy(rotation: ComplexF)

Rotates this object by a rotation.

rotatedAroundPointBy

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

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

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

rotatedAroundPointTo

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

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

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

rotatedBy

open override fun rotatedBy(rotation: AngleF): MutableLineSegment

open override fun rotatedBy(rotation: ComplexF): MutableLineSegment

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

rotatedTo

open override fun rotatedTo(orientation: AngleF): MutableLineSegment

open override fun rotatedTo(orientation: ComplexF): MutableLineSegment

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

rotateTo

open override fun rotateTo(orientation: AngleF)

open override fun rotateTo(orientation: ComplexF)

Rotates this object to the orientation.

scaleBy

open override fun scaleBy(factor: Float)

Scales this object by a factor.

scaledBy

open override fun scaledBy(factor: Float): MutableLineSegment

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

set

fun set(center: Vector2F = this.center, orientation: ComplexF = this.orientation, length: Float = this.length)

Sets the specified properties of this instance.

toString

open override fun toString(): String

transformBy

open override fun transformBy(displacement: Vector2F, rotation: AngleF)

open override fun transformBy(displacement: Vector2F, rotation: ComplexF)

Transforms this object by moving by a displacement and rotating by a rotation.

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

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

Transforms this object by moving by a displacement, rotating by a rotation, and scaling by a scaleFactor.

transformedBy

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

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

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): MutableLineSegment

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

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): MutableLineSegment

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

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

transformTo

open override fun transformTo(position: Vector2F, orientation: AngleF)

open override fun transformTo(position: Vector2F, orientation: ComplexF)

Transforms this object by moving to the position and rotating to the orientation.