MathKit/com.sztorm.mathkit.euclidean2d/MutableAnnulus

MutableAnnulus

class MutableAnnulus : Annulus, MutableTransformable

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

Constructors

constructor(center: Vector2F, orientation: ComplexF, outerRadius: Float, innerRadius: Float)

Creates a new instance of MutableAnnulus.

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

open override val innerDiameter: Float

Returns the inner diameter of this annulus.

open override val innerRadius: Float

Returns the inner radius of this annulus.

open override val orientation: ComplexF

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

open override val outerDiameter: Float

Returns the outer diameter of this annulus.

open override val outerRadius: Float

Returns the outer radius of this annulus.

open override val perimeter: Float

Returns the perimeter of this shape.

open override val position: Vector2F

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

open override val width: Float

Returns the width of this annulus. Width is the difference between the outer radius and the inner radius.

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

open operator override fun component1(): Vector2F

Returns the center of this annulus.

open operator override fun component2(): ComplexF

Returns the orientation of this annulus.

open operator override fun component3(): Float

Returns the outerRadius of this annulus.

open operator override fun component4(): Float

Returns the innerRadius of this annulus.

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

Returns true if this annulus contains the given point.

open operator override fun contains(annulus: Annulus): Boolean

Returns true if this annulus contains the whole given annulus.

open operator override fun contains(circle: Circle): Boolean

Returns true if this annulus contains the whole given circle.

open override fun copy(center: Vector2F, orientation: ComplexF, outerRadius: Float, innerRadius: Float): MutableAnnulus

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

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

fun equals(other: MutableAnnulus): Boolean

Indicates whether the other MutableAnnulus is equal to this one.

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

open override fun hashCode(): Int

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

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

open override fun interpolated(to: Annulus, by: Float): MutableAnnulus

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

open override fun intersects(annulus: Annulus): Boolean

Returns true if this annulus intersects the given annulus.

open override fun intersects(circle: Circle): Boolean

Returns true if this annulus intersects the given circle.

open override fun intersects(ray: Ray): Boolean

Returns true if this annulus intersects the given ray.

open override fun moveBy(displacement: Vector2F)

Moves this object by a displacement.

open override fun movedBy(displacement: Vector2F): MutableAnnulus

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

open override fun movedTo(position: Vector2F): MutableAnnulus

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

open override fun moveTo(position: Vector2F)

Moves this object to the position.

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

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

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

rotatedAroundPointTo

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

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

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

open override fun rotatedBy(rotation: AngleF): MutableAnnulus

open override fun rotatedBy(rotation: ComplexF): MutableAnnulus

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

open override fun rotatedTo(orientation: AngleF): MutableAnnulus

open override fun rotatedTo(orientation: ComplexF): MutableAnnulus

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

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

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

Sets the specified properties of this instance.

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

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

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

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

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

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

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.