orx-olive/org.openrndr.extra.olive

Package-level declarations

Types

class LoadException(message: String? = null, cause: Throwable? = null) : RuntimeException

class Olive<P : Program>(val resources: Resources? = null, scriptMode: ScriptMode = ScriptMode.KOTLIN_SCRIPT) : Extension

OliveProgram

open class OliveProgram(sourceLocation: String, scriptHost: OliveScriptHost, resources: Resources?) : ProgramImplementation

OliveScriptHost

enum OliveScriptHost : Enum<OliveScriptHost>

Once

class Once<T : Any>(val build: () -> T)

Delegate used to create instances exactly once. Instances survive a script reload.

Reloadable

open class Reloadable

A class with which persistent state can be reloaded from inside Olive scripts.

Resources

class Resources(val filterOutExtensions: List<String> = listOf())

ScriptLoadedEvent

@JvmRecord

data class ScriptLoadedEvent(val scriptFile: String) : Record

ScriptMode

enum ScriptMode : Enum<ScriptMode>

ScriptObjectLoader

class ScriptObjectLoader(classLoader: ClassLoader? = Thread.currentThread().contextClassLoader)

Functions

clearReloadables

fun clearReloadables()

Clear reloadable values

generateScript

inline fun <T> generateScript(programSource: ProgramSource): String

loadFromScript

inline fun <T : Any> loadFromScript(file: File, loader: ScriptObjectLoader = ScriptObjectLoader()): T

Load an object from script file

inline fun <T : Any> loadFromScript(fileOrUrl: String, loader: ScriptObjectLoader = ScriptObjectLoader()): T

Load an object from script.

loadFromScriptContents

inline fun <T : Any> loadFromScriptContents(contents: String, loader: ScriptObjectLoader = ScriptObjectLoader()): T

Load an object from script file

loadFromScriptContentsKSH

fun <T> loadFromScriptContentsKSH(script: String, host: BasicScriptingHost = BasicJvmScriptingHost(), body: ScriptCompilationConfiguration.Builder.() -> Unit = { jvm { dependenciesFromCurrentContext(wholeClasspath = true) } }): T

loadFromScriptKSH

fun <T> loadFromScriptKSH(script: File, host: BasicScriptingHost = BasicJvmScriptingHost(), body: ScriptCompilationConfiguration.Builder.() -> Unit = { jvm { dependenciesFromCurrentContext(wholeClasspath = true) } }): T

oliveProgram

fun ApplicationBuilder.oliveProgram(scriptHost: OliveScriptHost = OliveScriptHost.JSR223, resources: Resources? = null, init: OliveProgram.() -> Unit): OliveProgram

stackRootClassName

fun stackRootClassName(thread: Thread = Thread.currentThread(), sanitize: Boolean = true): String