commonMain.io.nacular.doodle.geometry.Shape.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-jvm Show documentation

A pure Kotlin, UI framework for the Web and Desktop

There is a newer version: 0.10.4

package io.nacular.doodle.geometry


/**
 * Objects implementing this interface represent shapes.
 */
public interface Shape {
    /** @return The bounding rectangle */
    public val boundingRectangle: Rectangle

    /** @return The Shape's area */
    public val area: Double

    /** @return true if the Shape's area is zero */
    public val empty: Boolean

    /**
     * Checks whether the Shape contains a given point.
     *
     * @param  point The point
     * @return true if the point is within the Shape
     */
    public operator fun contains(point: Point): Boolean

    /**
     * Checks whether the Shape contains a given rectangle.
     *
     * @param  rectangle The rectangle
     * @return true if the rectangle is within the Shape
     */
    public operator fun contains(rectangle: Rectangle): Boolean

    /**
     * Checks whether the Shape intersects a rectangle.
     *
     * @param  rectangle The rectangle
     * @return true if the Shape intersects the rectangle
     */
    public infix fun intersects(rectangle: Rectangle): Boolean
}