This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
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
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.

WidgetCheckBox Class

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits: 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).

WidgetCheckBox Class

Members


static WidgetCheckBox ( Gui gui, string str = 0 ) #

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

Arguments

  • Gui gui - GUI, to which the new checkbox will belong.
  • string str - Checkbox label. This is an optional parameter.

static WidgetCheckBox ( string str = 0 ) #

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

Arguments

  • string str - Checkbox label. This is an optional parameter.

void setChecked ( int checked ) #

Sets a value indicating if the checkbox is selected.

Arguments

  • int checked - Positive number to check (select) the checkbox, 0 to uncheck it.

int isChecked ( ) #

Returns a value indicating if the checkbox is selected.

Return value

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

void setText ( string text ) #

Sets a checkbox text label.

Arguments

  • string text - Checkbox label.

string getText ( ) #

Returns the checkbox text label.

Return value

Checkbox label.

void setCheckedColor ( vec4 color ) #

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

Arguments

  • vec4 color - Four-component vector specifying the color in the RGBA format.

vec4 getCheckedColor ( ) #

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 ( vec4 color ) #

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

Arguments

  • vec4 color - Four-component vector specifying the color in the RGBA format.

vec4 getUncheckedColor ( ) #

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: 2020-07-31
Build: ()