MathKit/com.sztorm.mathkit.euclidean2d/MutableRegularPolygon

MutableRegularPolygon

class MutableRegularPolygon : RegularPolygon, MutableTransformable

Represents a mutable transformable regular polygon in a two-dimensional Euclidean space.

Constructors

MutableRegularPolygon

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

Creates a new instance of MutableRegularPolygon.

constructor(regularTriangle: MutableRegularTriangle)

Creates a new instance of MutableRegularPolygon from given regularTriangle.

constructor(square: MutableSquare)

Creates a new instance of MutableRegularPolygon from given square.

Types

object Companion

Properties

open override val area: Float

Returns the area of this shape.

open override val center: Vector2F

Returns the center of this regular polygon.

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 inradius: Float

Returns the inradius of this shape.

open override val interiorAngle: AngleF

Returns the interior angle of this shape.

open override 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 override val points: Vector2FList

Returns the read-only list of points of this regular polygon.

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.

open override val sideLength: Float

Returns the side length of this shape.

Functions

fun calibrate()

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

open override fun closestPointTo(point: Vector2F): Vector2F

Returns the closest point on this regular polygon to the given point.

open operator override fun component1(): Vector2F

Returns the center of this regular polygon.

open operator override fun component2(): ComplexF

Returns the orientation of this regular polygon.

open operator override fun component3(): Float

Returns the sideLength of this regular polygon.

open operator override fun component4(): Int

Returns the sideCount of this regular polygon.

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

Returns true if this regular polygon contains the given point.

open override fun copy(center: Vector2F, orientation: ComplexF, sideLength: Float, sideCount: Int): MutableRegularPolygon

Returns a copy of this instance with specified properties changed.

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

Dilates this object around the point by a factor.

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

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

fun equals(other: MutableRegularPolygon): Boolean

Indicates whether the other MutableRegularPolygon is equal to this one.

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

open override fun hashCode(): Int

open override fun intersects(ray: Ray): Boolean

Returns true if this regular polygon intersects the given ray.

open override fun moveBy(displacement: Vector2F)

Moves this object by a displacement.

open override fun movedBy(displacement: Vector2F): MutableRegularPolygon

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

open override fun movedTo(position: Vector2F): MutableRegularPolygon

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

open override fun moveTo(position: Vector2F)

Moves this object to the position.

open override fun pointIterator(): Vector2FIterator

Creates an iterator over the points of this regular polygon.

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.

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

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

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

rotatedAroundPointTo

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

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

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

open override fun rotatedBy(rotation: AngleF): MutableRegularPolygon

open override fun rotatedBy(rotation: ComplexF): MutableRegularPolygon

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

open override fun rotatedTo(orientation: AngleF): MutableRegularPolygon

open override fun rotatedTo(orientation: ComplexF): MutableRegularPolygon

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

open override fun rotateTo(orientation: AngleF)

open override fun rotateTo(orientation: ComplexF)

Rotates this object to the orientation.

open override fun scaleBy(factor: Float)

Scales this object by a factor.

open override fun scaledBy(factor: Float): MutableRegularPolygon

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

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

Sets the specified properties of this instance.

toMutableRegularTriangleOrNull

fun toMutableRegularTriangleOrNull(): MutableRegularTriangle?

Creates a new instance of MutableRegularTriangle from this regular polygon if the sideCount is equal to 3, otherwise returns null.

toMutableSquareOrNull

fun toMutableSquareOrNull(): MutableSquare?

Creates a new instance of MutableSquare from this regular polygon if the sideCount is equal to 4, otherwise returns null.

toRegularTriangleOrNull

open override fun toRegularTriangleOrNull(): RegularTriangle?

Creates a new instance of RegularTriangle from this regular polygon if the sideCount is equal to 3, otherwise returns null.

open override fun toSquareOrNull(): Square?

Creates a new instance of Square from this regular polygon if the sideCount is equal to 4, otherwise returns null.

open override fun toString(): String

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.

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

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

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

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

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

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

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

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.