GUI

open class GUI(val appearance: GUIAppearance = GUIAppearance(), val defaultStyles: List<StyleSheet> = defaultStyles()) : Extension(source)

Constructors

GUI

constructor(appearance: GUIAppearance = GUIAppearance(), defaultStyles: List<StyleSheet> = defaultStyles())

Types

ParameterValue

@Serializable

class ParameterValue(var doubleValue: Double? = null, var intValue: Int? = null, var booleanValue: Boolean? = null, var colorValue: ColorRGBa? = null, var vector2Value: Vector2? = null, var vector3Value: Vector3? = null, var vector4Value: Vector4? = null, var doubleListValue: MutableList<Double>? = null, var textValue: String? = null, var optionValue: String? = null, var minValue: Double? = null, var maxValue: Double? = null)

Properties

appearance

val appearance: GUIAppearance

canvas

var canvas: Canvas?

collapsed

val collapsed: ElementClass

compartmentsCollapsedByDefault

var compartmentsCollapsedByDefault: Boolean

defaultSaveFolder

var defaultSaveFolder: String

defaultStyles

val defaultStyles: List<StyleSheet>

doubleBind

var doubleBind: Boolean

enabled

open override var enabled: Boolean

enableSideCanvas

var enableSideCanvas: Boolean

listenToProduceAssetsEvent

var listenToProduceAssetsEvent: Boolean

persistState

var persistState: Boolean

showToolbar

var showToolbar: Boolean

visible

var visible: Boolean

Functions

add

fun <T : Any> add(objectWithParameters: T, label: String? = objectWithParameters.title()): T

Add an object to the GUI

fun <T : Any> add(label: String? = null, builder: () -> T): T

Add an object to the GUI using a builder.

afterDraw

open override fun afterDraw(drawer: Drawer, program: Program)

beforeDraw

open fun beforeDraw(drawer: Drawer, program: Program)

fromObject

fun fromObject(labeledValues: Map<String, Map<String, GUI.ParameterValue>>)

Can be called by the user to update the gui using an object deserialized externally. Allows the user to load a larger json object, deserialize it, and use part of it to update the GUI. Complements .toObject().

loadParameters

fun loadParameters(file: File)

onChange

fun onChange(listener: (name: String, value: Any?) -> Unit)

randomize

fun randomize(strength: Double = 0.05)

remove

fun <T : Any> remove(objectWithParameters: T)

Remove an object from the GUI.

saveParameters

fun saveParameters(file: File)

setup

open override fun setup(program: Program)

shutdown

open override fun shutdown(program: Program)

toObject

fun toObject(): Map<String, Map<String, GUI.ParameterValue>>

Can be called by the user to obtain an object to be serialized externally. This allows the user to combine custom data with gui state and save it all to one file. Complements .fromObject().