This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
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
Content Creation
Content Optimization
Materials
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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).

Example#

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

Source code (C++)
#include <UnigineWidgets.h>
using namespace Unigine;

/* .. */

// event handler function
int onCheckBoxChanged()
{
	/* .. */
	
	return 1;
}

/* .. */

// getting a pointer to the system GUI
GuiPtr gui = Gui::get();

// 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->addCallback(Gui::CHANGED, MakeCallback(onCheckBoxChanged));

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

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 - 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

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 - 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

Four-component vector specifying the color in the RGBA format.
Last update: 2021-04-29
Build: ()