MathKit/com.sztorm.mathkit.euclidean2d/MutableSquare

MutableSquare

class MutableSquare : Square, MutableTransformable

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

Constructors

MutableSquare

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

Creates a new instance of MutableSquare.

Types

Companion

object Companion

Properties

area

open override val area: Float

Returns the area of this shape.

center

open override val center: Vector2F

Returns the center of this square.

circumradius

open override val circumradius: Float

Returns the circumradius of this shape.

exteriorAngle

open override val exteriorAngle: AngleF

Returns the exterior angle of this shape.

height

open override val height: Float

Returns the height of this square.

inradius

open override val inradius: Float

Returns the inradius of this shape.

interiorAngle

open override val interiorAngle: AngleF

Returns the interior angle of this shape.

orientation

open override 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 override val pointA: Vector2F

Returns the point A of this square.

pointB

open override val pointB: Vector2F

Returns the point B of this square.

pointC

open override val pointC: Vector2F

Returns the point C of this square.

pointD

open override val pointD: Vector2F

Returns the point D of this square.

position

open override val position: Vector2F

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

sideCount

open override val sideCount: Int

Returns the side count of this shape.

sideLength

open override val sideLength: Float

Returns the side length of this shape.

width

open override val width: Float

Returns the width of this square.

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 square to the given point.

component1

open operator override fun component1(): Vector2F

Returns the center of this square.

component2

open operator override fun component2(): ComplexF

Returns the orientation of this square.

component3

open operator override fun component3(): Float

Returns the sideLength of this square.

contains

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

Returns true if this square contains the given point.

copy

open override fun copy(center: Vector2F, orientation: ComplexF, sideLength: Float): MutableSquare

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

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

equals

fun equals(other: MutableSquare): Boolean

Indicates whether the other MutableSquare is equal to this one.

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

hashCode

open override fun hashCode(): Int

interpolate

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

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

interpolated

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

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

intersects

open override fun intersects(ray: Ray): Boolean

Returns true if this square intersects the given ray.

moveBy

open override fun moveBy(displacement: Vector2F)

Moves this object by a displacement.

movedBy

open override fun movedBy(displacement: Vector2F): MutableSquare

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

movedTo

open override fun movedTo(position: Vector2F): MutableSquare

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

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

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

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

rotatedAroundPointTo

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

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

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

rotatedBy

open override fun rotatedBy(rotation: AngleF): MutableSquare

open override fun rotatedBy(rotation: ComplexF): MutableSquare

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

rotatedTo

open override fun rotatedTo(orientation: AngleF): MutableSquare

open override fun rotatedTo(orientation: ComplexF): MutableSquare

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

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

set

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

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

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

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

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

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

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

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.