openrndr-shape/org.openrndr.shape/Circle

Circle

@Serializable

data class Circle(val center: Vector2, val radius: Double) : Movable, Scalable1D, ShapeProvider, ShapeContourProvider, LinearType<Circle> , GeometricPrimitive2D(source)

Represents a circle defined by its center and radius.

This class provides methods to manipulate and query the circle's properties, including scaling, moving, and generating its shape representation. It also offers utility functions to create circles based on specific points.

Constructors

Circle

constructor(center: Vector2, radius: Double)

Types

Companion

object Companion

Properties

area

val area: Double

center

val center: Vector2

The central point of the circle represented as a Vector2.

contour

open override val contour: ShapeContour

Returns ShapeContour representation of the Circle.

corner

val corner: Vector2

The top-left corner of the Circle.

radius

val radius: Double

The radius of the circle as a Double.

scale

open override val scale: Vector2

Current scale of this shape. Generally equivalent to its dimensions.

shape

open override val shape: Shape

Returns Shape representation of the Circle.

Functions

contains

operator fun contains(point: Vector2): Boolean

Checks if the given point is located inside the circle.

div

open operator override fun div(scale: Double): Circle

minus

open operator override fun minus(right: Circle): Circle

movedBy

open override fun movedBy(offset: Vector2): Circle

Creates a new shape with the same size but the current position offset by the given amount.

movedTo

open override fun movedTo(center: Vector2): Circle

Creates a new Circle with center at center.

plus

open operator override fun plus(right: Circle): Circle

position

open override fun position(u: Double, v: Double): Vector2

Returns a position in the bounding box for parameterized values u and v between 0.0 and 1.0 where (0.5, 0.5) is the center of the bounding box.

open fun position(uv: Vector2): Vector2

Returns a position in the bounding box for a parameterized uv value between (0.0, 0.0) and (1.0, 1.0) where (0.5, 0.5) is the center of the bounding box.

scaledBy

open override fun scaledBy(scale: Double, uAnchor: Double, vAnchor: Double): Circle

Creates a new shape with dimensions scaled by scale.

scaledTo

open override fun scaledTo(radius: Double): Circle

Creates a new Circle at the same position with the given radius.

times

open operator override fun times(scale: Double): Circle