commonMain.org.openrndr.Extension.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openrndr-application

openrndr-application

The newest version!

package org.openrndr

import org.openrndr.draw.Drawer

@DslMarker
annotation class ExtensionDslMarker

/**
 * Indicates the stage in which the extension is
 */
enum class ExtensionStage {
    SETUP,
    BEFORE_DRAW,
    AFTER_DRAW
}

interface ExtensionHost : InputEvents {
    val extensions: MutableList

    fun  extend(extension: T): T
    fun  extend(extension: T, configure: T.() -> Unit): T

    fun extend(stage: ExtensionStage = ExtensionStage.BEFORE_DRAW, userDraw: Program.() -> Unit)

    val program: Program
}


/**
 * Defines a Program extension. This is the interface for developers of OPENRNDR extensions.
 */
@ExtensionDslMarker
interface Extension {
    var enabled: Boolean
    fun setup(program: Program) {}
    fun beforeDraw(drawer: Drawer, program: Program) {}
    fun afterDraw(drawer: Drawer, program: Program) {}

    /**
     * Shutdown is called when the host application is quit
     */
    fun shutdown(program: Program) {}
}