Kawalan Pengguna

Kawalan pengguna dalam plugin berbentuk pemboleh ubah global yang boleh diubah oleh pengguna akhir. Semuanya dieksport melalui ControllableParameters() dari plugin, yang mengembalikan array objek tetapan seperti yang ditunjukkan di bawah.

export function ControllableParameters(){
    return [
        {"property":"LightingMode", "label":"Lighting Mode", "type":"combobox", "values":["Canvas","Forced"], "default":"Canvas"},
        {"property":"forcedColor", "label":"Forced Color","min":"0","max":"360","type":"color","default":"#009bde"},
        {"property":"SettingControl", "label":"Enable Setting Control","type":"boolean","default":"false"},
        {"property":"dpi1", "label":"DPI","step":"50", "type":"number","min":"200", "max":"18000","default":"800"}
    ];
}

Objek tetapan ini sentiasa mempunyai beberapa parameter asas. Ini terpakai untuk semua kawalan pengguna plugin.

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	Jenis kawalan. Pilihan yang sah pada masa ini ialah: boolean, number, hue, color, combobox, dan textfield	String
default	Nilai lalai untuk kawalan.	Berbeza-beza

Peluncur Nombor

Kawalan number membolehkan pengguna memilih nilai nombor melalui peluncur.

{"property":"dpi1", "label":"DPI","step":"50", "type":"number","min":"200", "max":"18000","default":"800"},

Kawalan ini menyokong atribut berikut:

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	”number”	String
default	Nilai lalai untuk kawalan.	String, Int
min	Nilai minimum yang boleh dipilih untuk peluncur. Atribut ini menyokong nilai negatif.	String, Int
max	Nilai maksimum yang boleh dipilih untuk peluncur.	String, Int
step	Saiz langkah peluncur meningkat dan berkurang.	String, Int

Suis Boolean

Kawalan boolean membolehkan pengguna memilih nilai pemboleh ubah boolean melalui kawalan togol.

{"property":"AngleSnap", "label":"Angle Snapping", "type":"boolean", "default":"0"},

Kawalan ini menyokong atribut berikut:

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	”boolean”	String
default	Nilai lalai untuk suis. Tetapkan ini kepada 1 untuk menjadikan “Hidup” sebagai keadaan lalai.	String, Int

Peluncur Rona

Kawalan hue membolehkan pengguna memilih komponen rona warna melalui peluncur.

Kawalan ini menyokong atribut berikut:

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	”hue”	String, Int
default	Nilai lalai untuk peluncur rona.	String
min	Nilai rona minimum yang boleh dipilih. Nilai ini mesti antara 0 dan 359.	String, Int
max	Nilai rona maksimum yang boleh dipilih. Nilai ini mesti antara 1 dan 360.	String, Int

Pemilih Warna

Kawalan color membolehkan pengguna memilih warna melalui roda rona, peluncur ketepuan, dan peluncur kecerahan. Ikon kunci boleh laras membuka palet warna lanjutan untuk dipilih.

{"property":"forcedColor", "label":"Forced Color","min":"0","max":"360","type":"color","default":"#009bde"},

Kawalan ini menyokong atribut berikut:

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	”color”	String
default	Nilai lalai untuk pemilih warna. Ini mesti diberikan sebagai nilai hex dalam bentuk #RRGGBB.	String
min	Nilai rona minimum yang boleh dipilih. Nilai ini mesti antara 0 dan 359.	Int
max	Nilai rona maksimum yang boleh dipilih. Nilai ini mesti antara 1 dan 360.	Int

Kotak Gabungan

Kawalan combobox membolehkan pengguna memilih dari menu lungsur dengan nilai yang telah ditetapkan.

{"property":"SleepModeTime", "label":"Sleep After x Minutes", "type":"combobox", "values":[5,10,15,30,60], "default":10},

Kawalan ini menyokong atribut berikut:

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	”combobox”	String
default	Nilai lalai untuk kotak gabungan. Nilai ini mesti wujud dalam array values.	String, Int
values	Array nilai untuk menu lungsur. Jenis yang sah ialah strings dan integer.	[String, Int]

Medan Teks

Kawalan textfield membolehkan pengguna memasukkan teks secara bebas, pilihan dengan penapis RegEx.

{"property":"textBox", "label":"Text Field", "type":"textfield", "default":"3"},

Kawalan ini menyokong atribut berikut:

Parameter	Nilai	Jenis
property	Nama pemboleh ubah yang ingin Anda tugaskan kepada kawalan.	String
label	Label yang dipaparkan kepada pengguna.	String
type	”textfield”	String
default	Nilai lalai untuk medan teks.	String, Int
filter	Penapis RegEx pilihan untuk mengehadkan input pengguna.	String RegEx

Callback on*Changed

Setiap kali pengguna menukar kawalan, SignalRGB memanggil fungsi on[property]Changed() yang sepadan sebelum panggilan Render() seterusnya. Nama fungsi mesti sepadan tepat dengan nama property dari ControllableParameters(), dengan awalan on dan akhiran Changed. Huruf besar/kecil dititikberatkan.

// Entri ControllableParameters:
{"property":"dpi1", "label":"DPI", "step":"50", "type":"number", "min":"200", "max":"18000", "default":"800"},

// Callback yang sepadan:
export function ondpi1Changed() {
    setDpi(dpi1);
}

Callback Terbina Dalam

Callback ini tersedia tanpa entri ControllableParameters yang sepadan:

Fungsi	Keterangan
onBrightnessChanged()	Dipanggil apabila pengguna menggerakkan peluncur kecerahan utama peranti.