Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ColorPicker

Eredita: VBoxContainer < BoxContainer < Container < Control < CanvasItem < Node < Object

Un widget che fornisce un'interfaccia per selezionare o modificare un colore.

Descrizione

Un widget che fornisce un'interfaccia per selezionare o modificare un colore. Può opzionalmente fornire funzionalità come un campionatore di colori (contagocce), modalità colore e preimpostazioni.

Nota: Questo controllo è il widget di selezione colore stesso. È possibile usare un ColorPickerButton al suo posto se è necessario un pulsante che faccia apparire un ColorPicker in un popup.

Tutorial

Demo di interpolazione Tween

Proprietà

bool	can_add_swatches	`true`
Color	color	`Color(1, 1, 1, 1)`
ColorModeType	color_mode	`0`
bool	color_modes_visible	`true`
bool	deferred_mode	`false`
bool	edit_alpha	`true`
bool	edit_intensity	`true`
bool	hex_visible	`true`
PickerShapeType	picker_shape	`0`
bool	presets_visible	`true`
bool	sampler_visible	`true`
bool	sliders_visible	`true`

Metodi

void	add_preset(color: Color)
void	add_recent_preset(color: Color)
void	erase_preset(color: Color)
void	erase_recent_preset(color: Color)
PackedColorArray	get_presets() const
PackedColorArray	get_recent_presets() const

Proprietà del tema

Color	focused_not_editing_cursor_color	`Color(1, 1, 1, 0.275)`
int	center_slider_grabbers	`1`
int	h_width	`30`
int	label_width	`10`
int	margin	`4`
int	sv_height	`256`
int	sv_width	`256`
Texture2D	add_preset
Texture2D	bar_arrow
Texture2D	color_copy
Texture2D	color_hue
Texture2D	color_script
Texture2D	expanded_arrow
Texture2D	folded_arrow
Texture2D	menu_option
Texture2D	overbright_indicator
Texture2D	picker_cursor
Texture2D	picker_cursor_bg
Texture2D	sample_bg
Texture2D	sample_revert
Texture2D	screen_picker
Texture2D	shape_circle
Texture2D	shape_rect
Texture2D	shape_rect_wheel
StyleBox	picker_focus_circle
StyleBox	picker_focus_rectangle
StyleBox	sample_focus

Segnali

color_changed(color: Color) 🔗

Emesso quando il colore cambia.

preset_added(color: Color) 🔗

Emesso quando una preimpostazione viene aggiunta.

preset_removed(color: Color) 🔗

Emesso quando una preimpostazione viene rimossa.

Enumerazioni

enum ColorModeType: 🔗

ColorModeType MODE_RGB = 0

Consente di modificare il colore con gli slider del rosso, verde e blu nello spazio colore sRGB.

ColorModeType MODE_HSV = 1

Consente di modificare il colore con i cursori della tonalità , saturazione e valore.

ColorModeType MODE_RAW = 2

Deprecato: This is replaced by MODE_LINEAR.

ColorModeType MODE_LINEAR = 2

Consente di modificare il colore con gli slider del rosso, verde e blu nello spazio colore lineare.

ColorModeType MODE_OKHSL = 3

Consente di modificare il colore con gli slider del tonalità, saturazione e valore.

OKHSL è un nuovo spazio colore simile a HSL ma che si adatta meglio alla percezione sfruttando lo spazio colore Oklab che è progettato per essere semplice da usare, facendo un buon lavoro nel prevedere la luminosità, la crominanza e la tonalità percepite.

Spazi colore Okhsv e Okhsl

enum PickerShapeType: 🔗

PickerShapeType SHAPE_HSV_RECTANGLE = 0

Spazio colore rettangolare del modello di colore HSV.

PickerShapeType SHAPE_HSV_WHEEL = 1

Spazio colore rettangolare del modello di colore HSV con una ruota.

PickerShapeType SHAPE_VHS_CIRCLE = 2

Spazio colore circolare del modello di colore HSV. Usa la saturazione come raggio.

PickerShapeType SHAPE_OKHSL_CIRCLE = 3

Spazio colore circolare del modello di colore HSL OK.

PickerShapeType SHAPE_NONE = 4

La forma dello spazio colore e il pulsante di selezione della forma sono nascosti. Non possono essere selezionati dal popup delle forme.

PickerShapeType SHAPE_OK_HS_RECTANGLE = 5

Modello di colore OKHSL rettangolare con luminosità costante.

PickerShapeType SHAPE_OK_HL_RECTANGLE = 6

Modello di colore OKHSL rettangolare con saturazione costante.

Descrizioni delle proprietà

bool can_add_swatches = true 🔗

void set_can_add_swatches(value: bool)
bool are_swatches_enabled()

Se true, è possibile aggiungere preset in Campioni. Se false, il pulsante per aggiungere preset è disabilitato.

Color color = Color(1, 1, 1, 1) 🔗

void set_pick_color(value: Color)
Color get_pick_color()

Il colore attualmente selezionato.

ColorModeType color_mode = 0 🔗

void set_color_mode(value: ColorModeType)
ColorModeType get_color_mode()

La modalità di colore attualmente selezionata.

bool color_modes_visible = true 🔗

void set_modes_visible(value: bool)
bool are_modes_visible()

Se true, i pulsanti della modalità colore sono visibili.

bool deferred_mode = false 🔗

void set_deferred_mode(value: bool)
bool is_deferred_mode()

Se true, il colore sarà applicato solo dopo che l'utente rilascia il pulsante del mouse, altrimenti sarà applicato immediatamente anche in caso di movimento del mouse (il che può causare problemi di prestazioni).

bool edit_alpha = true 🔗

void set_edit_alpha(value: bool)
bool is_editing_alpha()

Se true, mostra uno slider per il canale alfa (opacità).

bool edit_intensity = true 🔗

void set_edit_intensity(value: bool)
bool is_editing_intensity()

If true, shows an intensity slider. The intensity is applied as follows: convert the color to linear encoding, multiply it by 2 ** intensity, and then convert it back to nonlinear sRGB encoding.

bool hex_visible = true 🔗

void set_hex_visible(value: bool)
bool is_hex_visible()

Se true, il campo di input del codice colore esadecimale è visibile.

PickerShapeType picker_shape = 0 🔗

void set_picker_shape(value: PickerShapeType)
PickerShapeType get_picker_shape()

La forma della vista dello spazio colore.

bool presets_visible = true 🔗

void set_presets_visible(value: bool)
bool are_presets_visible()

Se true, le preimpostazioni dei Campioni e dei Colori recenti sono visibili.

bool sampler_visible = true 🔗

void set_sampler_visible(value: bool)
bool is_sampler_visible()

Se true, il campionatore e l'anteprima del colore sono visibili.

bool sliders_visible = true 🔗

void set_sliders_visible(value: bool)
bool are_sliders_visible()

Se true, gli slider del colore sono visibili.

Descrizioni dei metodi

void add_preset(color: Color) 🔗

Aggiunge il colore specificato a una lista di preimpostazioni di colore. Le preimpostazioni sono visualizzate nel selettore colore e l'utente potrà selezionarli.

Nota: La lista delle preimpostazioni è solo per questo selettore colore.

void add_recent_preset(color: Color) 🔗

Aggiunge il colore specificato a una lista di preset di colore recenti affinché possa essere scelto in seguito. I preset recenti sono i colori scelti di recente, un nuovo preset è creato automaticamente e aggiunto ai preset recenti quando selezioni un nuovo colore.

Nota: La lista dei preset recenti è solo per questo selettore di colori.

void erase_preset(color: Color) 🔗

Rimuove il colore specificato dalla lista dei colori predefiniti di questo selettore di colori.

void erase_recent_preset(color: Color) 🔗

Rimuove il colore specificato dalla lista dei colori preimpostati di recente di questo selettore di colori.

PackedColorArray get_presets() const 🔗

Restituisce la lista dei colori nei preset del selettore di colori.

PackedColorArray get_recent_presets() const 🔗

Restituisce la lista dei colori presenti nei preset recenti del selettore di colori.

Descrizioni delle proprietà del tema

Color focused_not_editing_cursor_color = Color(1, 1, 1, 0.275) 🔗

Colore del rettangolo o del cerchio disegnato quando una parte della forma del selettore è evidenziata ma non modificabile tramite tastiera o joypad. È visualizzato sopra la forma del selettore, quindi è consigliabile utilizzare un colore parzialmente trasparente per garantire che la forma del selettore rimanga visibile.

int center_slider_grabbers = 1 🔗

Sostituisce la proprietà del tema Slider.center_grabber degli slider.

int h_width = 30 🔗

Larghezza dello slider di selezione della tonalità.

int label_width = 10 🔗

Larghezza minima delle etichette di colore accanto agli slider.

int margin = 4 🔗

Il margine attorno al ColorPicker.

int sv_height = 256 🔗

Altezza del riquadro di selezione del valore di saturazione.

int sv_width = 256 🔗

Larghezza del riquadro di selezione del valore di saturazione.

Texture2D add_preset 🔗

L'icona per il pulsante "Aggiungi preset".

Texture2D bar_arrow 🔗

La texture per il grabber a freccia.

Texture2D color_copy 🔗

The icon for the button that copies the color in text format to the clipboard.

Texture2D color_hue 🔗

Texture personalizzata per lo slider di selezione della tonalità sulla destra.

Texture2D color_script 🔗

L'icona per il pulsante che cambia il colore da testo a esadecimale.

Texture2D expanded_arrow 🔗

L'icona per il menu a tendina dei preset di colori quando è espanso.

Texture2D folded_arrow 🔗

L'icona per il menu a tendina dei preset di colori quando è chiuso.

L'icona per il menu a tendina dei preset di colori.

Texture2D overbright_indicator 🔗

Indicatore utilizzato per segnalare che il valore del colore è al di fuori dell'intervallo 0-1.

Texture2D picker_cursor 🔗

L'immagine visualizzata sopra il riquadro o cerchio dei colori (a seconda di picker_shape), che contrassegna il colore attualmente selezionato.

Texture2D picker_cursor_bg 🔗

L'immagine di riempimento visualizzata dietro il cursore del selettore.

Texture2D sample_bg 🔗

Pannello di sfondo per il riquadro di anteprima del colore (visibile quando il colore è traslucido).

Texture2D sample_revert 🔗

L'icona per il pulsante di ripristino (visibile al centro del colore "vecchio" quando è diverso dal colore attualmente selezionato). Questa icona è modulata con un colore scuro se il colore "vecchio" è abbastanza luminoso, quindi l'icona dovrebbe essere chiara per garantire la visibilità in entrambi gli scenari.

Texture2D screen_picker 🔗

L'icona per il pulsante di preleva colore dallo schermo.

Texture2D shape_circle 🔗

L'icona per le forme circolari del selettore.

Texture2D shape_rect 🔗

L'icona per le forme rettangolari del selettore.

Texture2D shape_rect_wheel 🔗

L'icona per le forme rettangolari della ruota di selezione.

StyleBox picker_focus_circle 🔗

Lo StyleBox utilizzato quando la parte circolare del selettore è evidenziata. È visualizzato sopra la forma del selettore, quindi è necessario utilizzare uno StyleBox parzialmente trasparente per garantire che la forma del selettore rimanga visibile. Uno StyleBox che rappresenta un contorno o una sottolineatura funziona bene per questo scopo. Per disabilitare l'effetto visivo del focus, assegna una risorsa StyleBoxEmpty. Tieni presente che disattivare l'effetto visivo di focus ridurrà l'usabilità della navigazione tramite tastiera o controller, perciò non è consigliato per motivi di accessibilità.

StyleBox picker_focus_rectangle 🔗

Lo StyleBox utilizzato quando la parte rettangolare del selettore è evidenziata. È visualizzato sopra la forma del selettore, quindi è necessario utilizzare uno StyleBox parzialmente trasparente per garantire che la forma del selettore rimanga visibile. Uno StyleBox che rappresenta un contorno o una sottolineatura funziona bene per questo scopo. Per disabilitare l'effetto visivo del focus, assegna una risorsa StyleBoxEmpty. Tieni presente che disattivare l'effetto visivo di focus ridurrà l'usabilità della navigazione tramite tastiera o controller, perciò non è consigliato per motivi di accessibilità.

StyleBox sample_focus 🔗

Lo StyleBox utilizzato per la parte del campione del colore precedente quando è evidenziato. È visualizzato sopra il campione, quindi è necessario utilizzare uno StyleBox parzialmente trasparente per garantire che la forma del selettore rimanga visibile. Uno StyleBox che rappresenta un contorno o una sottolineatura funziona bene per questo scopo. Per disabilitare l'effetto visivo del focus, assegna una risorsa StyleBoxEmpty. Tieni presente che disattivare l'effetto visivo di focus ridurrà l'usabilità della navigazione tramite tastiera o controller, perciò non è consigliato per motivi di accessibilità.