Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
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
CIGI Client Plugin
Rendering-Related Classes
This version of documentation is OUTDATED! Please switch to the latest one.

Unigine::WidgetLabel Class

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

This class creates a text label.

See Also#

  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/widgets/ folder:
    • font_03
    • font_04
    • font_05
    • font_06
    • font_07
  • UnigineScript API sample <UnigineSDK>/data/samples/objects/gui_06


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

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

/* .. */

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

// creating a label widget and setting up its caption
WidgetLabelPtr widget_label = WidgetLabel::create(gui, "Label text");

// setting a tooltip
widget_label->setToolTip("This is a label");

// rearranging label size

// setting label position
widget_label->setPosition(10, 10);
// adding created label widget to the system GUI
gui->addChild(widget_label->getWidget(), Gui::ALIGN_OVERLAP | Gui::ALIGN_FIXED);

WidgetLabel Class


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

Constructor. Creates a new text label.


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

Ptr<WidgetLabel> cast ( const Ptr<Widget> & widget ) #

Casts a WidgetLabel out of the Widget instance.


  • const Ptr<Widget> & widget - Pointer to Widget.

Return value

Pointer to WidgetLabel.

void setText ( const char * text ) #

Sets a text for the label.


  • const char * text - Label text.

const char * getText ( ) #

Returns the text of the label.

Return value

Label text.

void setTextAlign ( int align ) #

Sets alignment of the label.


  • int align - One of the Gui:: Enumeration with ALIGN_* prefixes.

int getTextAlign ( ) #

Returns alignment of the label.

Return value

Alignment of the label: one of the Gui:: Enumeration with ALIGN_* prefixes.

int type ( ) #

WidgetLabel type.

Return value

WidgetLabel type identifier.
Last update: 2019-08-16
Build: ()