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

Успадковує: VBoxContainer < BoxContainer < Container < Control < CanvasItem < Node < Object

Віджет, який надає інтерфейс для вибору або зміни кольору.

Опис

Віджет, який надає інтерфейс для вибору або зміни кольору. Ви можете додатково надати функціональні можливості, такі як кольоровий пробовідбірник, кольорові режими та пресети.

Примітка: Цей контроль є самим кольором пікера віджету. Ви можете використовувати ColorPickerButton замість того, якщо вам потрібна кнопка, яка приносить ColorPicker в попупці.

Посібники

Демонстрація інтерполяції Tween

Властивості

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`

Методи

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

Властивості теми

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

Сигнали

color_changed(color: Color) 🔗

Випробувано, коли колір змінюється.

preset_added(color: Color) 🔗

Випробувано при доданні.

preset_removed(color: Color) 🔗

Випробувано при видаленні пресету.

Переліки

enum ColorModeType: 🔗

ColorModeType MODE_RGB = 0

Дозволяє редагувати колір за допомогою повзунків Червоний/Зелений/Синій у колірному просторі sRGB.

ColorModeType MODE_HSV = 1

Дозволяє редагувати колір Hue/Saturation/Value слайдери.

ColorModeType MODE_RAW = 2

Застаріло: This is replaced by MODE_LINEAR.

ColorModeType MODE_LINEAR = 2

Дозволяє редагувати колір за допомогою повзунків Червоний/Зелений/Синій у лінійному колірному просторі.

ColorModeType MODE_OKHSL = 3

Дозволяє редагувати колір Hue/Saturation/Lightness sliders.

OKHSL є новим кольоровим простором, схожим на HSL, але що краще відповідати сприйняттю, використовуючи колірний простір Oklab, який призначений для того, щоб бути простим у використанні, при цьому зробити хорошу роботу при прогнозуванні сприйнятливості, аромату і відтінку.

Okhsv і Okhsl кольорові простори

enum PickerShapeType: 🔗

PickerShapeType SHAPE_HSV_RECTANGLE = 0

HSV Колір Модель прямокутника колір простору.

PickerShapeType SHAPE_HSV_WHEEL = 1

Кольорова модель HSV кольоровий простір з колесом.

PickerShapeType SHAPE_VHS_CIRCLE = 2

HSV Колір Модель коло колір простору. Використовуйте насиченість як радіус.

PickerShapeType SHAPE_OKHSL_CIRCLE = 3

HSL OK Колір Модель кола колір простору.

PickerShapeType SHAPE_NONE = 4

Кольорова форма простору і форма виберіть кнопка прихована. Не можна вибрати з форми.

PickerShapeType SHAPE_OK_HS_RECTANGLE = 5

Прямокутник кольорової моделі OKHSL з постійною яскравістю.

PickerShapeType SHAPE_OK_HL_RECTANGLE = 6

Прямокутник кольорової моделі OKHSL з постійною насиченістю.

Описи властивостей

bool can_add_swatches = true 🔗

void set_can_add_swatches(value: bool)
bool are_swatches_enabled()

Якщо true, можна додати пресети під Swatches. Якщо false, кнопка для додавання пресетів вимкнена.

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

void set_pick_color(value: Color)
Color get_pick_color()

В даний час обраний колір.

ColorModeType color_mode = 0 🔗

void set_color_mode(value: ColorModeType)
ColorModeType get_color_mode()

Поточний вибраний колірний режим.

bool color_modes_visible = true 🔗

void set_modes_visible(value: bool)
bool are_modes_visible()

Якщо true, кнопки кольорових режимів відображаються.

bool deferred_mode = false 🔗

void set_deferred_mode(value: bool)
bool is_deferred_mode()

Якщо true, колір буде застосовуватися тільки після того, як користувач випускає кнопку миші, інакше він буде застосовуватися відразу навіть у випадку руху миші (що може викликати проблеми виконання).

bool edit_alpha = true 🔗

void set_edit_alpha(value: bool)
bool is_editing_alpha()

Якщо true, показує альфа-канал слайдер (опакуратність).

bool edit_intensity = true 🔗

void set_edit_intensity(value: bool)
bool is_editing_intensity()

Якщо значення true, відображається повзунок інтенсивності. Інтенсивність застосовується наступним чином: колір перетворюється на лінійне кодування, помножується на 2 ** інтенсивність, а потім перетворюється назад на нелінійне кодування sRGB.

bool hex_visible = true 🔗

void set_hex_visible(value: bool)
bool is_hex_visible()

Якщо true, поле вхідного коду Hex видимий.

PickerShapeType picker_shape = 0 🔗

void set_picker_shape(value: PickerShapeType)
PickerShapeType get_picker_shape()

Форма перегляду колірного простору.

bool presets_visible = true 🔗

void set_presets_visible(value: bool)
bool are_presets_visible()

Якщо true, Swatches і останні кольори пресетів видно.

bool sampler_visible = true 🔗

void set_sampler_visible(value: bool)
bool is_sampler_visible()

Якщо true, видимий колірний зразок і кольоровий попередній перегляд.

bool sliders_visible = true 🔗

void set_sliders_visible(value: bool)
bool are_sliders_visible()

Якщо true, видимі кольорові слайдери.

Описи методів

void add_preset(color: Color) 🔗

Додавання даного кольору до списку кольорових пресетів. Приставки відображаються в кольорі пікірувальник і користувач зможе вибрати їх.

Примітка: this color picker.

void add_recent_preset(color: Color) 🔗

Додає заданий колір до списку кольорових недавніх пресетів, щоб він був обраний пізніше. Недавні пресети - це кольори, які були підібрані нещодавно, новий заміщений і додано в останні пресети, коли ви підбираєте новий колір.

Примітка: Останній список пресетів тільки для this кольоровий пікір.

void erase_preset(color: Color) 🔗

Видаліть заданий колір з переліку кольорових пресетів цього кольорового маркера.

void erase_recent_preset(color: Color) 🔗

Видаліть заданий колір з переліку кольорових останніх пресетів цього кольорового маркера.

PackedColorArray get_presets() const 🔗

Повертає список кольорів в пресетах кольорового маркера.

PackedColorArray get_recent_presets() const 🔗

Повертає список кольорів в останні пресети кольорового маркера.

Описи тематичної нерухомості

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

Колір прямокутника або кола, що малюється, коли частина фігури вибору фокусована, але не може бути редагувана за допомогою клавіатури або джойстика. Відображається поверх фігури вибору, тому слід використовувати частково прозорий колір, щоб забезпечити видимість фігури вибору.

int center_slider_grabbers = 1 🔗

Надіславши Slider.center_grabber тематичне майно слайдерів.

int h_width = 30 🔗

Ширина ходової підбірки слайдера.

int label_width = 10 🔗

Мінімальна ширина кольорових етикеток поруч з гірками.

int margin = 4 🔗

Поле навколо ColorPicker.

int sv_height = 256 🔗

Висота оздоблювального ящика.

int sv_width = 256 🔗

Ширина оздоблювального ящика.

Texture2D add_preset 🔗

Піктограма кнопки «Додати пресет».

Texture2D bar_arrow 🔗

Текстура для стрілоподібної крупи.

Texture2D color_copy 🔗

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

Texture2D color_hue 🔗

Користувальницькі фактури для вибору відтінку слайдера праворуч.

Texture2D color_script 🔗

Піктограма кнопки, яка перемикає колір тексту на шістнадцятковий.

Texture2D expanded_arrow 🔗

Ікона при розширюванні колірної застібки.

Texture2D folded_arrow 🔗

Ікона для кольорового заміщення випадаючого меню при складанні.

Піктограма для меню попередньо встановлених кольорів.

Texture2D overbright_indicator 🔗

Індикатор використовується для сигналізації, що значення кольору поза діапазоном 0-1.

Texture2D picker_cursor 🔗

Зображення, що відображається поверх кольорового поля/кола (залежно від picker_shape), позначаючи поточний вибраний колір.

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 використовується, коли фокусується кругла частина вибору. Відображається поверх форми вибору, тому слід використовувати частково прозорий StyleBox, щоб забезпечити видимість форми вибору. StyleBox, який представляє контур або підкреслення, добре підходить для цієї мети. Щоб вимкнути візуальний ефект фокусування, призначте ресурс StyleBoxEmpty. Зверніть увагу, що вимкнення візуального ефекту фокусування погіршить зручність навігації за допомогою клавіатури/контролера, тому це не рекомендується з міркувань доступності.

StyleBox picker_focus_rectangle 🔗

StyleBox використовується, коли фокусується прямокутна частина вибору. Відображається поверх форми вибору, тому слід використовувати частково прозорий StyleBox, щоб забезпечити видимість форми вибору. StyleBox, який представляє контур або підкреслення, добре підходить для цієї мети. Щоб вимкнути візуальний ефект фокусування, призначте ресурс StyleBoxEmpty. Зверніть увагу, що вимкнення візуального ефекту фокусування погіршить зручність навігації за допомогою клавіатури/контролера, тому це не рекомендується з міркувань доступності.

StyleBox sample_focus 🔗

StyleBox використовується для старої частини зразка кольору, коли вона у фокусі. Відображається поверх зразка, тому слід використовувати частково прозорий StyleBox, щоб забезпечити видимість форми вибору. StyleBox, який представляє контур або підкреслення, добре підходить для цієї мети. Щоб вимкнути візуальний ефект фокусування, призначте ресурс StyleBoxEmpty. Зверніть увагу, що вимкнення візуального ефекту фокусування погіршить зручність навігації клавіатурою/контролером, тому це не рекомендується з міркувань доступності.