This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::WidgetLabel Class

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

This class creates a text label.

See Also#

  • Widgets sample in C# Component Samples suite
  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/widgets/ folder:
    • font_00
    • font_01
    • font_02
    • font_03
    • font_04
    • font_05
  • UnigineScript API sample <UnigineSDK>/data/samples/objects/gui_04

Example#

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
widget_label->arrange();

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

WidgetLabel Class

Members


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

Constructor. Creates a new text label and adds it to the specified GUI.

Arguments

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

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

Constructor. Creates a new text label and adds it to the Engine GUI.

Arguments

  • const char * str - Text of the label. This is an optional parameter.

void setText ( const char * text ) #

Sets a text for the label.

Arguments

  • const char * text - Label text.

const char * getText ( ) const#

Returns the text of the label.

Return value

Label text.

void setTextAlign ( int align ) #

Sets alignment of the label.

Arguments

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

int getTextAlign ( ) const#

Returns alignment of the label.

Return value

Alignment of the label: one of the Gui:: Enumeration with ALIGN_* prefixes.
Last update: 2024-08-16
Build: ()