Contrôles utilisateur

Les contrôles utilisateur dans un plugin prennent la forme d’une variable globale qui peut être modifiée par l’utilisateur final. Ils sont tous exportés depuis le plugin via ControllableParameters() qui retourne un tableau d’objets de paramètres comme indiqué ci-dessous.

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"}
    ];
}

Ces objets de paramètres ont toujours quelques paramètres de base. Ceux-ci sont valides pour tous les contrôles utilisateur du plugin.

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	Le type de contrôle. Actuellement, les options suivantes sont valides : boolean, number, hue, color, combobox, and textfield	String
default	La valeur par défaut pour le contrôle.	Variable

Curseur numérique

Le contrôle numérique permet à l’utilisateur de sélectionner la valeur d’un nombre à l’aide d’un curseur.

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

Ce contrôle prend en charge les attributs suivants :

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	”number”	String
default	La valeur par défaut pour le contrôle.	String, Int
min	La valeur minimale sélectionnable pour le curseur. Cet attribut prend en charge les valeurs négatives.	String, Int
max	La valeur maximale sélectionnable pour le curseur.	String, Int
step	La valeur de pas par laquelle le curseur s’incrémente et se décrémente	String, Int

Interrupteur booléen

Le contrôle booléen permet à l’utilisateur de sélectionner la valeur d’une variable booléenne à l’aide d’un contrôle à bascule.

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

Ce contrôle prend en charge les attributs suivants :

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	”boolean”	String
default	La valeur par défaut pour la bascule. Définissez-la à 1 pour que “activé” soit l’état par défaut.	String, Int

Curseur de teinte

Le contrôle sélecteur de teinte permet à l’utilisateur de sélectionner la composante de teinte d’une couleur avec un curseur.

Ce contrôle prend en charge les attributs suivants :

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	”hue”	String, Int
default	La valeur par défaut pour le curseur de teinte.	String
min	La valeur de teinte minimale sélectionnable. Cette valeur doit être comprise entre 0 et 359.	String, Int
max	La valeur de teinte maximale sélectionnable. Cette valeur doit être comprise entre 1 et 360.	String, Int

Sélecteur de couleur

Le contrôle de couleur permet à l’utilisateur de sélectionner une couleur à l’aide d’une roue de teinte, d’un curseur de saturation et d’un curseur de luminance. L’icône de clé ouvrira une palette de couleurs plus avancée pour la sélection.

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

Ce contrôle prend en charge les attributs suivants :

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	”color”	String
default	La valeur par défaut pour le sélecteur de couleur. Elle doit être spécifiée comme une valeur hexadécimale au format #RRGGBB	String
min	La valeur de teinte minimale sélectionnable. Cette valeur doit être comprise entre 0 et 359.	Int
max	La valeur de teinte maximale sélectionnable. Cette valeur doit être comprise entre 1 et 360.	Int

Liste déroulante

Le contrôle de liste déroulante permet à l’utilisateur de sélectionner parmi un menu déroulant de valeurs prédéfinies.

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

Ce contrôle prend en charge les attributs suivants :

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	”combobox”	String
default	La valeur par défaut pour la liste déroulante. Cette valeur doit être dans le tableau values.	String, Int
values	Un tableau de valeurs pour le menu déroulant. Les types valides sont les chaînes et les entiers.	[String, Int]

Champ de texte

Le contrôle de champ de texte permet à l’utilisateur de saisir librement du texte avec un filtre RegEx optionnel.

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

Ce contrôle prend en charge les attributs suivants :

Paramètre	Valeur	Type
property	Le nom de la variable que vous souhaitez associer au contrôle.	String
label	L’étiquette à afficher à l’utilisateur.	String
type	”textfield”	String
default	La valeur par défaut pour le champ de texte.	String, Int
filter	un filtre RegEx optionnel pour limiter la saisie de l’utilisateur	RegEx String