annotation class DoubleListParameter(val label: String, val low: Double = -1.0, val high: Double = 1.0, val minimumListLength: Int = 1, val maximumListLength: Int = 16, val precision: Int = 3, val order: Int = Int.MAX_VALUE)

DoubleListParameter annotation for a double precision parameter

DoubleParameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DoubleParameter(val label: String, val low: Double, val high: Double, val precision: Int = 3, val order: Int = Int.MAX_VALUE)

DoubleParameter annotation for a double precision parameter

IntParameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class IntParameter(val label: String, val low: Int, val high: Int, val order: Int = Int.MAX_VALUE)

IntParameter annotation for an integer parameter

OptionParameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class OptionParameter(val label: String, val order: Int = Int.MAX_VALUE)

OptionParameter annotation for a double precision parameter

Parameter

class Parameter(val parameterType: ParameterType, val property: KMutableProperty1<out Any, Any?>?, val function: KCallable<Unit>?, val label: String, val doubleRange: ClosedRange<Double>?, val vectorRange: Pair<Vector2, Vector2>?, val sizeRange: ClosedRange<Int>?, val intRange: IntRange?, val precision: Int?, val invertY: Boolean?, val showVector: Boolean?, val absolutePath: Boolean?, val pathContext: String?, val pathExtensions: Array<String>?, val pathIsDirectory: Boolean?, val order: Int)

Parameter summary class. This is used by listParameters as a way to report parameters in a unified form.

ParameterType

enum ParameterType : Enum<ParameterType>

PathParameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class PathParameter(val label: String, val absolute: Boolean = false, val context: String = "null", val extensions: Array<String> = [], val directory: Boolean = false, val order: Int = Int.MAX_VALUE)

ActionParameter annotation for functions without arguments

TextParameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TextParameter(val label: String, val order: Int = Int.MAX_VALUE)

TextParameter annotation for a text parameter

Vector2Parameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Vector2Parameter(val label: String, val min: Double = -1.0, val max: Double = 1.0, val precision: Int = 2, val order: Int = Int.MAX_VALUE)

Vector3Parameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Vector3Parameter(val label: String, val min: Double = -1.0, val max: Double = 1.0, val precision: Int = 2, val order: Int = Int.MAX_VALUE)

Vector4Parameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Vector4Parameter(val label: String, val min: Double = -1.0, val max: Double = 1.0, val precision: Int = 2, val order: Int = Int.MAX_VALUE)

XYParameter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class XYParameter(val label: String, val minX: Double = -1.0, val maxX: Double = 1.0, val minY: Double = -1.0, val maxY: Double = 1.0, val precision: Int = 2, val showVector: Boolean = false, val invertY: Boolean = true, val order: Int = Int.MAX_VALUE)

Vector2 annotation for a vector 2 parameter

Properties

parameterAnnotationClasses

val ParameterType.Companion.parameterAnnotationClasses: List<KClass<out Annotation>>

Functions

description

expect fun Any.description(): String?

actual fun Any.description(): String?

forParameterAnnotationClass

fun ParameterType.Companion.forParameterAnnotationClass(annotation: Annotation): ParameterType

listParameters

fun Any.listParameters(): List<Parameter>

title

expect fun Any.title(): String?

List all parameters, (public var properties with a parameter annotation)

actual fun Any.title(): String?