MathKit/com.sztorm.mathkit.euclidean2d/Square

Square

interface Square : RectangleShape, RegularShape, Transformable

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

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

Inheritors

Properties

open override val area: Float

Returns the area of this shape.

abstract val center: Vector2F

Returns the center of this square.

open override val circumradius: Float

Returns the circumradius of this shape.

open override val exteriorAngle: AngleF

Returns the exterior angle of this shape.

open override val height: Float

Returns the height of this square.

open override val inradius: Float

Returns the inradius of this shape.

open override val interiorAngle: AngleF

Returns the interior angle of this shape.

abstract val orientation: ComplexF

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

open override val perimeter: Float

Returns the perimeter of this shape.

open val pointA: Vector2F

Returns the point A of this square.

open val pointB: Vector2F

Returns the point B of this square.

open val pointC: Vector2F

Returns the point C of this square.

open val pointD: Vector2F

Returns the point D of this square.

open override val position: Vector2F

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

open override val sideCount: Int

Returns the side count of this shape.

abstract val sideLength: Float

Returns the side length of this shape.

open override val width: Float

Returns the width of this square.

Functions

open fun closestPointTo(point: Vector2F): Vector2F

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

open operator fun component1(): Vector2F

Returns the center of this square.

open operator fun component2(): ComplexF

Returns the orientation of this square.

open operator fun component3(): Float

Returns the sideLength of this square.

open operator fun contains(point: Vector2F): Boolean

Returns true if this square contains the given point.

abstract fun copy(center: Vector2F = this.center, orientation: ComplexF = this.orientation, sideLength: Float = this.sideLength): Square

Returns a copy of this instance with specified properties changed.

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

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

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

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

open fun intersects(ray: Ray): Boolean

Returns true if this square intersects the given ray.

open override fun movedBy(displacement: Vector2F): Square

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

open override fun movedTo(position: Vector2F): Square

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

open fun pointIterator(): Vector2FIterator

Creates an iterator over the points of this square.

rotatedAroundPointBy

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

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

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

rotatedAroundPointTo

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

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

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

open override fun rotatedBy(rotation: AngleF): Square

open override fun rotatedBy(rotation: ComplexF): Square

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

open override fun rotatedTo(orientation: AngleF): Square

open override fun rotatedTo(orientation: ComplexF): Square

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

open override fun scaledBy(factor: Float): Square

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

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

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

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

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

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

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

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

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