54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
# orx-parameters
|
|
|
|
A collection of annotations and tools that are used to turn Kotlin properties into introspectable parameters. Parameters
|
|
are highly suitable for automatically generating user interfaces, but note that this is _not_ what `orx-parameters` does.
|
|
|
|
For an example (and a highly usable implementation) of generating interfaces from the annotations you are encouraged to check out [`orx-gui`](../orx-gui/README.md).
|
|
|
|
Currently orx-parameters supplies the following annotations:
|
|
|
|
- `DoubleParameter` for `Double` properties
|
|
- `IntParameter` for `Int` properties
|
|
- `BooleanParameter` for `Boolean` properties
|
|
- `TextParameter` for `String` properties
|
|
- `ColorParameter` for `ColorRGBa` properties
|
|
|
|
Additionally there is an `ActionParameter` that can be used to annotate functions without arguments.
|
|
|
|
## Annotation application
|
|
|
|
Annotations can be applied to a properties inside a class or object class.
|
|
|
|
````kotlin
|
|
val foo = object {
|
|
@DoubleParameter("a double scalar", 0.0, 1.0, order = 0)
|
|
var d = 1.0
|
|
|
|
@IntParameter("an integer scalar", 1, 100, order = 1)
|
|
var i = 1
|
|
|
|
@BooleanParameter("a boolean parameter", order = 2)
|
|
var b = false
|
|
|
|
@ActionParameter("a simple action", order = 3)
|
|
fun actionFunction() {
|
|
// --
|
|
}
|
|
|
|
}
|
|
````
|
|
|
|
## Querying parameters
|
|
|
|
Given an instance of an annotated class we can list the parameters using the extension method
|
|
`Any.listParameters()` of our previously declared object `foo`
|
|
|
|
```kotlin
|
|
import org.openrndr.extra.parameters.listParameters
|
|
|
|
// ..
|
|
|
|
val parameters = foo.listParameters()
|
|
```
|
|
|