Add descriptions to demos
This commit is contained in:
@@ -6,7 +6,17 @@ import org.openrndr.math.Vector2
|
||||
import org.openrndr.math.Vector3
|
||||
import org.openrndr.math.Vector4
|
||||
|
||||
|
||||
/**
|
||||
* Demonstrates how to use RabbitControl to create a web-based user interface for your program.
|
||||
*
|
||||
* A `settings` object is created using the same syntax used for `orx-gui`, including
|
||||
* annotations for different variable types.
|
||||
*
|
||||
* The program then passes these `settings` to the `RabbitControlServer`. A QR-code is displayed
|
||||
* to open the web user interface. A clickable URL is also displayed in the console.
|
||||
*
|
||||
* Once the UI is visible in a web browser we can use it to control the OPENRNDR program.
|
||||
*/
|
||||
fun main() = application {
|
||||
configure {
|
||||
width = 800
|
||||
|
||||
@@ -4,6 +4,12 @@ import org.openrndr.color.ColorRGBa
|
||||
import org.openrndr.extra.parameters.BooleanParameter
|
||||
|
||||
|
||||
/**
|
||||
* Demonstrates how the QR-code pointing at the Rabbit Control web-based user interface
|
||||
* can be displayed and hidden manually.
|
||||
*
|
||||
* To display the QR-code overlay in this demo, hold down the HOME key in the keyboard.
|
||||
*/
|
||||
fun main() = application {
|
||||
configure {
|
||||
width = 800
|
||||
|
||||
@@ -6,7 +6,15 @@ import org.openrndr.math.Vector2
|
||||
import org.openrndr.math.Vector3
|
||||
import org.openrndr.math.Vector4
|
||||
|
||||
|
||||
/**
|
||||
* Starts the RabbitControlServer with a `Rabbithole` using the key 'orxtest'.
|
||||
*
|
||||
* `Rabbithole` allows you to access your exposed parameters from Internet
|
||||
* connected computers that are not in the same network.
|
||||
*
|
||||
* To use it with this example use 'orxtest' as the tunnel-name in https://rabbithole.rabbitcontrol.cc
|
||||
*
|
||||
*/
|
||||
fun main() = application {
|
||||
configure {
|
||||
width = 800
|
||||
@@ -14,13 +22,6 @@ fun main() = application {
|
||||
}
|
||||
|
||||
program {
|
||||
/**
|
||||
* Start RabbitControlServer with a Rabbithole with key 'orxtest'
|
||||
* Please visit https://rabbithole.rabbitcontrol.cc for more information.
|
||||
*
|
||||
* Rabbithole allows you to access your exposed parameter from the internet.
|
||||
* To use it with this example just use 'orxtest' as tunnel-name on the main page.
|
||||
*/
|
||||
val rabbit = RabbitControlServer(false, 10000, 8080, "wss://rabbithole.rabbitcontrol.cc/public/rcpserver/connect?key=orxtest")
|
||||
val font = loadFont("demo-data/fonts/IBMPlexMono-Regular.ttf", 20.0)
|
||||
val settings = object {
|
||||
|
||||
Reference in New Issue
Block a user