This page has been translated automatically.
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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client 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.

Unigine::WidgetExternBase Class

Header:#include <UnigineWidgets.h>

The base class, from which the custom user-defined widgets are inherited.

WidgetExternBase Class


int getClassID()

Returns a unique class ID.

Return value

Unique class ID.

Ptr<Gui> getGui()

Returns the Gui smart pointer.

Return value

Gui smart pointer.

int getKeyActivity(unsigned int key)

Checks the keyboard key.


  • unsigned int key - Key code.

Return value

Returns 1 if the key is used by widget.

int isOwner()

Returns the owner flag of the pointer. If the pointer is owner, on its deletion the object also will be deleted.

Return value

The owner flag.

Ptr<Widget> getWidget()

Returns the Widget smart pointer.

Return value

Widget smart pointer.

Ptr<WidgetExtern> getWidgetExtern()

Returns the WidgetExtern smart pointer.

Return value

WidgetExtern smart pointer.

void arrange()

Calculates the widget size.

void checkCallbacks(int x, int y)

Checks widget callbacks.


  • int x - Mouse X coordinate.
  • int y - Mouse Y coordinate.

void destroy()

Destroys the widget resources.

void expand(int width, int height)

Expands the widget size.


  • int width - Maximum available width.
  • int height - Maximum available height.

void grab()

Sets the owner flag to 1 for the widget pointer. The widget should not be handled by the class after this function is called.

void keyPress(unsigned int key)

Keyboard press event.


  • unsigned int key - Key code.

void release()

Sets the owner flag to 0 for the widget pointer. The widget should be handled by the class after this function is called.

void render()

Renders the widget.

void update(float ifps)

Widget update function.


  • float ifps - Inverse FPS value.
Last update: 2018-06-04
Build: ()