This page has been translated automatically.
Видеоуроки
Интерфейс
Основы
Продвинутый уровень
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Профессиональный уровень (SIM)
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Режимы вывода изображения
Физика
Браузер SDK 2
Лицензирование и типы лицензий
Дополнения (Add-Ons)
Демонстрационные проекты
API Samples
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Контроль версий
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Sandworm
Использование инструментов редактора для конкретных задач
Расширение функционала редактора
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World-ноды
Звуковые объекты
Объекты поиска пути
Player-ноды
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
Унифицированный язык шейдеров UUSL (Unified UNIGINE Shader Language)
Плагины
Форматы файлов
Материалы и шейдеры
Rebuilding the Engine Tools
Интерфейс пользователя (GUI)
Двойная точность координат
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Визуальный редактор материалов
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Учебные материалы
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

Unigine::WidgetCheckBox Class

Header: #include <UnigineWidgets.h>
Inherits from: Widget

This class creates checkboxes. A set of checkboxes can be converted into a radio buttons group (that act as a single mutually exclusive control), if all the checkboxes are attached to a certain one among them (for example, the first).

See Also#

Example#

The following code illustrates how to create a checkbox widget and set its parameters.

AppWorldLogic.cpp
#include "AppWorldLogic.h"
#include <UnigineWidgets.h>

using namespace Unigine;

/* .. */

// event handler function
int onCheckBoxEventChanged()
{
	/* .. */

	return 1;
}
// create an instance of the EventConnection class
EventConnection connection;

/* .. */

int AppWorldLogic::init()
{
	GuiPtr gui = Gui::getCurrent();

	// creating a checkbox widget and setting its caption
	WidgetCheckBoxPtr widget_checkbox = WidgetCheckBox::create(gui, "Automatic mode");

	// setting a tooltip
	widget_checkbox->setToolTip("Toggle automatic mode");

	// rearranging checkbox size
	widget_checkbox->arrange();

	// setting checkbox position
	widget_checkbox->setPosition(10, 10);

	// setting checkbox state to checked
	widget_checkbox->setChecked(1);

	// setting onCheckBoxChanged function to handle CHANGED event
	widget_checkbox->getEventChanged().connect(connection, onCheckBoxEventChanged);

	// adding created checkbox widget to the system GUI
	gui->addChild(widget_checkbox, Gui::ALIGN_OVERLAP | Gui::ALIGN_FIXED);

	return 1;
}

// ...

int AppWorldLogic::shutdown()
{
	// removing an event subscriptions
	connection.disconnect();
	return 1;
}

WidgetCheckBox Class

Members


static WidgetCheckBoxPtr create ( const Ptr<Gui> & gui, const char * str = 0 ) #

Constructor. Creates a checkbox with a given text label and adds it to the specified GUI.

Arguments

  • const Ptr<Gui> & gui - GUI, to which the new checkbox will belong.
  • const char * str - Checkbox label. This is an optional parameter.

static WidgetCheckBoxPtr create ( const char * str = 0 ) #

Constructor. Creates a checkbox with a given text label and adds it to the Engine GUI.

Arguments

  • const char * str - Checkbox label. This is an optional parameter.

void setChecked ( bool checked ) #

Sets a value indicating if the checkbox is selected.

Arguments

  • bool checked - 1 to check (select) the checkbox, 0 to uncheck it.

bool isChecked ( ) const#

Returns a value indicating if the checkbox is selected.

Return value

1 if the checkbox is checked (selected); otherwise, 0.

void setText ( const char * text ) #

Sets a checkbox text label.

Arguments

  • const char * text - Checkbox label.

const char * getText ( ) const#

Returns the checkbox text label.

Return value

Checkbox label.

void setCheckedColor ( const Math::vec4 & color ) #

Sets the color to be used for the checked widget's state.

Arguments

  • const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getCheckedColor ( ) const#

Returns the current color used for the checked widget's state.

Return value

The four-component vector specifying the color in the RGBA format.

void setUncheckedColor ( const Math::vec4 & color ) #

Sets the color to be used for the unchecked widget's state.

Arguments

  • const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getUncheckedColor ( ) const#

Returns the current color used for the unchecked widget's state.

Return value

The four-component vector specifying the color in the RGBA format.
Last update: 16.08.2024
Build: ()