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)(source)

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

Constructors

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

Properties

Link copied to clipboard
Link copied to clipboard

a floating point based range in case DoubleParameter is used

Link copied to clipboard

a function that received the ActionParameter

Link copied to clipboard

an integer range in case IntParameter is used

Link copied to clipboard

should the y-axis of XYParameter be inverted?

Link copied to clipboard

a label that describes the property

Link copied to clipboard
val order: Int

a hint for where in the ui this parameter is placed, lower value means higher priority

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

a precision hint in case a DoubleParameter annotation is used

Link copied to clipboard

a property that received any of the parameter annotations BooleanParameter, IntParameter, or DoubleParameter

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val vectorRange: Pair<Vector2, Vector2>?