MathKit/com.sztorm.mathkit.euclidean2d/Rectangle

Rectangle

interface Rectangle : RectangleShape, Transformable

Represents a transformable rectangle in a two-dimensional Euclidean space.

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

Inheritors

MutableRectangle

Properties

area

open override val area: Float

Returns the area of this shape.

center

abstract val center: Vector2F

Returns the center of this rectangle.

height

abstract val height: Float

Returns the height of this rectangle.

orientation

abstract val orientation: ComplexF

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

perimeter

open override val perimeter: Float

Returns the perimeter of this shape.

pointA

open val pointA: Vector2F

Returns the point A of this rectangle.

pointB

open val pointB: Vector2F

Returns the point B of this rectangle.

pointC

open val pointC: Vector2F

Returns the point C of this rectangle.

pointD

open val pointD: Vector2F

Returns the point D of this rectangle.

position

open override val position: Vector2F

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

width

abstract val width: Float

Returns the width of this rectangle.

Functions

closestPointTo

open fun closestPointTo(point: Vector2F): Vector2F

Returns the closest point on this rectangle to the given point.

component1

open operator fun component1(): Vector2F

Returns the center of this rectangle.

component2

open operator fun component2(): ComplexF

Returns the orientation of this rectangle.

component3

open operator fun component3(): Float

Returns the width of this rectangle.

component4

open operator fun component4(): Float

Returns the height of this rectangle.

contains

open operator fun contains(point: Vector2F): Boolean

Returns true if this rectangle contains the given point.

copy

abstract fun copy(center: Vector2F = this.center, orientation: ComplexF = this.orientation, width: Float = this.width, height: Float = this.height): Rectangle

Returns a copy of this instance with specified properties changed.

dilatedBy

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

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

interpolated

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

Returns a copy of this rectangle interpolated to other rectangle by a factor.

intersects

open fun intersects(ray: Ray): Boolean

Returns true if this rectangle intersects the given ray.

movedBy

open override fun movedBy(displacement: Vector2F): Rectangle

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

movedTo

open override fun movedTo(position: Vector2F): Rectangle

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 rectangle.

rotatedAroundPointBy

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

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

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

rotatedAroundPointTo

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

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

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

rotatedBy

open override fun rotatedBy(rotation: AngleF): Rectangle

open override fun rotatedBy(rotation: ComplexF): Rectangle

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

rotatedTo

open override fun rotatedTo(orientation: AngleF): Rectangle

open override fun rotatedTo(orientation: ComplexF): Rectangle

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

scaledBy

open override fun scaledBy(factor: Float): Rectangle

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

transformedBy

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

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

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

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

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

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

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