This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
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
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
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
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.WidgetIcon Class

Inherits from: Widget

This class creates a toggleable icon with two states - pressed or not.

WidgetIcon Class

Properties

string Text#

The current floating text set to be over the icon.

int TextAlign#

The current alignment flag set for the floating text over the icon.

string Texture#

The path to the icon image.

bool Toggled#

The value indicating if the icon serving as a toggle button is pressed.

bool Toggleable#

The value indicating if the icon is a toggle button or a simple button. the default is 0.

Members


WidgetIcon ( Gui gui, string str = 0, int width = 0, int height = 0 ) #

Constructor. Creates an icon of the specified size using a given texture and adds it to the specified GUI.

Arguments

  • Gui gui - GUI, to which the new icon will belong.
  • string str - The path to a texture file.
  • int width - Icon width.
  • int height - Icon height.

WidgetIcon ( string str = 0, int width = 0, int height = 0 ) #

Constructor. Creates an icon of the specified size using a given texture and adds it to the Engine GUI.

Arguments

  • string str - The path to a texture file.
  • int width - Icon width.
  • int height - Icon height.

void SetImage ( Image image ) #

Sets an icon image.

Arguments

  • Image image - Image to set.

Image GetImage ( ) #

Returns the icon image.

Return value

Icon image.
Last update: 2022-12-14
Build: ()