MathKit/com.sztorm.mathkit.euclidean2d/Circle

Circle

interface Circle : CircleShape, Transformable

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

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

Inheritors

MutableCircle

Properties

area

open override val area: Float

Returns the area of this shape.

center

abstract val center: Vector2F

Returns the center of this circle.

diameter

open override val diameter: Float

Returns the diameter of this circle.

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.

position

open override val position: Vector2F

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

radius

abstract val radius: Float

Returns the radius of this circle.

Functions

closestPointTo

open fun closestPointTo(point: Vector2F): Vector2F

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

component1

open operator fun component1(): Vector2F

Returns the center of this circle.

component2

open operator fun component2(): ComplexF

Returns the orientation of this circle.

component3

open operator fun component3(): Float

Returns the radius of this circle.

contains

open operator fun contains(point: Vector2F): Boolean

Returns true if this circle contains the given point.

open operator fun contains(annulus: Annulus): Boolean

Returns true if this circle contains the whole given annulus.

open operator fun contains(circle: Circle): Boolean

Returns true if this circle contains the whole given circle.

copy

abstract fun copy(center: Vector2F = this.center, orientation: ComplexF = this.orientation, radius: Float = this.radius): Circle

Returns a copy of this instance with specified properties changed.

dilatedBy

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

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

interpolated

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

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

intersects

open fun intersects(annulus: Annulus): Boolean

Returns true if this circle intersects the given annulus.

open fun intersects(circle: Circle): Boolean

Returns true if this circle intersects the given circle.

open fun intersects(ray: Ray): Boolean

Returns true if this circle intersects the given ray.

movedBy

open override fun movedBy(displacement: Vector2F): Circle

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

movedTo

open override fun movedTo(position: Vector2F): Circle

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

rotatedAroundPointBy

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

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

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

rotatedAroundPointTo

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

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

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

rotatedBy

open override fun rotatedBy(rotation: AngleF): Circle

open override fun rotatedBy(rotation: ComplexF): Circle

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

rotatedTo

open override fun rotatedTo(orientation: AngleF): Circle

open override fun rotatedTo(orientation: ComplexF): Circle

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

scaledBy

open override fun scaledBy(factor: Float): Circle

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

transformedBy

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

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

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

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

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

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

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